kbase / sample_service

Service for creating, modifying, and retrieving samples
MIT License
0 stars 11 forks source link

SAM-209 organize documentation #452

Closed eapearson closed 2 years ago

eapearson commented 2 years ago

This set of changes is designed to satisfy SAM-209. It attempts to do so by:

In addition, I've cherrypicked a few new documents from SAM-96, from which this work was initially copied. This is because this set of changes should also satisfy the needs of the changes for SAM-96, which needs to add several documents and diagrams. Separate from SAM-209, it was requested to remove the document reorganization from SAM-96, so adding these additional changes here allows us to base those changes on this work.

eapearson commented 2 years ago

I see the release notes in the docs directory. I think I would prefer to keep those at the top. I see it is empty so maybe the intent was something else.

That was intended to be a document about creating release notes, as it is located in the documentation directory of the docs directory. I've updated the empty document to have a title and a quote-blocked reminder to complete the content.

There is already a RELEASE_NOTES.md in the project root.

Interestingly, I've found that some Python projects locate release notes within the documentation folder, not at the project root. I found this a bit baffling at first, but it does make some sense, as it could be argued that for a documentation set to be complete it should include a description of the evolution of the product over time, including release notes.

eapearson commented 2 years ago

Resolved a new merge conflict introduced by concurrent changes to RELEASE_NOTES.md