Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the ADE information model #300

Open
cookeac opened this issue May 19, 2022 · 5 comments
Open

Document the ADE information model #300

cookeac opened this issue May 19, 2022 · 5 comments
Labels
next-minor-release The issue is not scheduled for the current release, but planned for a release soon after that.

Comments

@cookeac
Copy link
Collaborator

cookeac commented May 19, 2022

Create model documentation including diagrams

@cookeac
Copy link
Collaborator Author

cookeac commented May 19, 2022

@cookeac
Copy link
Collaborator Author

cookeac commented May 20, 2022

Relates to #258 but probably initially more informal and diagrammatic.

@stale
Copy link

stale bot commented Aug 30, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale-issue Identifies that an issue is stale and will be closed unless reactivated. label Aug 30, 2022
@cookeac cookeac removed the stale-issue Identifies that an issue is stale and will be closed unless reactivated. label Aug 30, 2022
cookeac added a commit to cookeac/ICAR that referenced this issue Oct 20, 2022
Preview of documentation (much more to be done)
- Explanation of animal sets and groups (resolves adewg#272)
- Start of ADE information model documentation (adewg#300)
@cookeac cookeac added the next-minor-release The issue is not scheduled for the current release, but planned for a release soon after that. label Nov 3, 2022
@gra-moore
Copy link
Collaborator

@cookeac We have this issue and another related which is to create a formal model. I think these things are almost the same. Defining the underlying data model would benefit understanding of whats in place, facilitate alternative semantic syntax representations. This would benefit the current release and provide a way to make this version work in the semantic tech world. Suggest we start work on this.

@cookeac
Copy link
Collaborator Author

cookeac commented Aug 24, 2023

Components:

  • Landing page(s) and maybe consider GitBook etc.
  • Ontology or semantic data dictionary --> Graham is willing to make a start on this so others can contribute
  • Information model document (with some diagrams)
  • Automated generation from the JSON schema?
  • Getting started guide (implementation)
  • Getting started guide - overview of the specification

Agreed to

  1. Create issues for each of the above
  2. Find someone to lead each
  3. Ask our organisations for volunteers to contribute or proofread

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next-minor-release The issue is not scheduled for the current release, but planned for a release soon after that.
Projects
None yet
Development

No branches or pull requests

2 participants