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

Update schema.md - reference introduction #146

Merged
merged 12 commits into from
Aug 4, 2023
Merged

Conversation

stufraser1
Copy link
Member

@stufraser1 stufraser1 commented Jul 26, 2023

Update introduction section to better reflect key elements of each component. Unsure whether class diagram should remain or be replaced with something derived directly from updated schema

Related issues

addresses #148

Merge checklist

  • Update the changelog (style guide)
  • Run ./manage.py pre-commit

update introduction section to better reflect key elements of each component.
Unsure whether class diagram should remain or be replaced with something derived directly from updated schema
matamadio
matamadio previously approved these changes Jul 28, 2023
docs/reference/schema.md Outdated Show resolved Hide resolved
Proposed shower descriptions for each component section, and edited the top summary. Text removed can be put into examples where they would be accompanied by code  snippets.
Copy link
Contributor

@odscjen odscjen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes a few typos and added some suggestions to improve the consistency of the description and ensure that in every case users understand that the standard is only detailing metadata.

docs/reference/schema.md Outdated Show resolved Hide resolved
docs/reference/schema.md Outdated Show resolved Hide resolved
docs/reference/schema.md Outdated Show resolved Hide resolved
docs/reference/schema.md Show resolved Hide resolved
docs/reference/schema.md Outdated Show resolved Hide resolved
docs/reference/schema.md Outdated Show resolved Hide resolved
docs/reference/schema.md Outdated Show resolved Hide resolved
Copy link
Member Author

@stufraser1 stufraser1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jen, can you check your comments have all been committed (some are outdated and I wanted to commit but couldn't)

Copy link
Contributor

@odscjen odscjen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of minor copy editing changes left.

Also don't forget to update the change log and run ./manage.py prior to the final commit

docs/reference/schema.md Outdated Show resolved Hide resolved
docs/reference/schema.md Outdated Show resolved Hide resolved
stufraser1 and others added 3 commits August 3, 2023 14:07
Add entry to Normative section
@stufraser1
Copy link
Member Author

update the change log and run ./manage.py prior to the final commit

Please run pre-commit, I have updated changelog.

@odscjen odscjen merged commit cc6b68d into dev Aug 4, 2023
4 checks passed
@odscjen odscjen deleted the docs_reference_intro branch August 4, 2023 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants