Overhaul documentation #1242
Merged
Overhaul documentation #1242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JPrevost
reviewed
Oct 16, 2023
|
@JPrevost I've pushed a commit to fix the issues you pointed out. Let me know if it makes sense, and if you have any additional feedback. Thanks! |
JPrevost
approved these changes
Oct 17, 2023
Why these changes are being introduced: The ETD readme includes a lot of outdated information and is lacking some information, including how to confirm that the app works. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/ENGX-227 * https://mitlibraries.atlassian.net/browse/ETD-631 How this addresses that need: This makes several changes to the readme, including (but not limited to): * Adding a section on how to confirm functionality after updating dependencies. * Adding a section on how we manage audit trails. * Adding a section on the processing workflow. * Rewriting the introduction to describe what the application currently does. * Updating information that is out of date. * Removing information that is inaccurate. * Reordering information where it seems appropriate, including changing header levels. There is more work to be done here, but my intention is that this will provide a solid foundation for future additions. Side effects of this change: * Added/adjusted line breaks for text that exceeded our line width. * Removed the docker files that were mentioned in the readme. I doubt we will ever use these, but I can add them back in if they are useful to others. * We still need to add diagrams. I'm hopeful that we'll be able to do that using the Rails mermaid gem, but GitHub doesn't seem to be ready for that just yet. Aside from the ERD, the various workflows are good candidates for flow diagrams.
jazairi
force-pushed
the
engx-227-confirm-functionality-docs
branch
from
f114c00 to
3d4b624
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why these changes are being introduced:
The ETD readme includes a lot of outdated information and is lacking some information, including how to confirm that the app works.
Relevant ticket(s):
How this addresses that need:
This makes several changes to the readme, including (but not limited to):
There is more work to be done here, but my intention is that this will provide a solid foundation for future additions.
Side effects of this change:
Developer
our guide and
all issues introduced by these changes have been resolved or opened as new
issues (link to those issues in the Pull Request details above)
Code Reviewer
(not just this pull request message)
Requires database migrations?
NO
Includes new or updated dependencies?
NO