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

ZH-253 #29

Merged
merged 39 commits into from
Oct 4, 2024
Merged

ZH-253 #29

merged 39 commits into from
Oct 4, 2024

Conversation

silviabah
Copy link
Contributor

@silviabah silviabah commented Sep 12, 2024

Summary

Adding the ISM documentation and schemas

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change which adds new content)
  • Modified content (non-breaking change which modifies existing content)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Motivation and Context

Adding the ISM documentation and schemas

References

ZenHub #253

Changes Introduced

Review

Documentation that will be modified in the future as some aspects of the SOP life cycle are define.

Additional Notes

Checklist:

General Compliance:

  • My changes follow the code style of this project (GDI SOP Style Guide) and the file naming conventions of the file accessioning proposal.
  • I have verified that all new updated content is accessible, including checking that all external references are readable (i.e., no broken links). These may include references to external resources that should be resolvable, and internal references among SOPs.
  • I have properly added this PR's changes to the repository CHANGELOG.md.

Only applicable if the PR includes new, or changes to, GDI SOPs (i.e., documents at sops/):

  • My SOP-related changes adhere to the Generic SOP Template, including format and required fields.
  • I have consulted the Charter, ISM, and ORR documents to ensure compliance.
  • I am complying with the established procedure for SOP creations and modifications, including respecting review phases and notifying needed contributors for reviews.

Copy link

@elisavettorstensson elisavettorstensson left a comment

Choose a reason for hiding this comment

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

I think you did a great job transferring the text from the Google Doc to Markdown! I especially liked the figures—they really help to clarify the text. Well done!

I’ve made a few comments on areas that might need some adjustments. I noticed that not all parts of the SOP were completed in the Google Doc, and they’re still missing here. I’m not sure if we need to finalize sections like 7.3 and 7.4 before we release the SOP. Overall, though, you’ve done excellent work with lots of potential for further improvement! :-)

docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
Copy link

@jmenglund jmenglund left a comment

Choose a reason for hiding this comment

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

Looks very good!

docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
.DS_Store Outdated Show resolved Hide resolved
Deleting unnecessary file
Deleting unnecessary file
Copy link
Collaborator

@M-casado M-casado left a comment

Choose a reason for hiding this comment

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

I like the new image a lot, well done. I haven't gone through all previous changes, but I assume they're resolved 👍

The only three things I noticed and would request changes:

  • You added a new .DS_Store that shouldn't be in the PR
  • Before merging this PR, change the name of the main file as mentioned above
  • Add your changes to the CHANGELOG file following its format (i.e. a line like ``information-service.... ... - Document detailing ...")

.DS_Store Outdated Show resolved Hide resolved
Copy link
Collaborator

@M-casado M-casado left a comment

Choose a reason for hiding this comment

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

Just added some suggestions in the new section

docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
docs/GDI-SOP_ISM.md Outdated Show resolved Hide resolved
@silviabah silviabah merged commit 449c2de into main Oct 4, 2024
1 of 2 checks passed
@M-casado M-casado deleted the ZH-253 branch October 4, 2024 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants