Update dev and deploy documentation to reflect new github actions - #71
Update dev and deploy documentation to reflect new github actions#71adamshire123 wants to merge 3 commits into
Conversation
Why these changes are being introduced: * Development and deployment processes have changed, and the documentation needs to be updated to reflect those changes. * The documentation had inconsistent punctuation, spelling, capitalization, and grammar throughout the readme. How this addresses that need: * Updates documentation to reflect new github actions * Fixes punctuation, spelling, capitalization, and grammar issues throughout Side effects of this change: none Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/NDE-87
There was a problem hiding this comment.
Pull request overview
Updates mit-readme.md to reflect the new GitHub Actions-based build/deploy workflow for development/testing, staging, and production, while also standardizing documentation style across the workflow steps.
Changes:
- Replaces local build/deploy instructions with GitHub Actions-based development and stage build guidance.
- Updates production deploy process to use tagging a GitHub release to generate the NDE artifact.
- Applies punctuation/capitalization/grammar cleanup across workflow sections.
Comments suppressed due to low confidence (6)
mit-readme.md:17
- Item 1 is missing a trailing period, which makes punctuation inconsistent with the rest of the numbered steps.
1. Clone this repository from GitHub (or just `git pull origin [new-nde-changes]` if you already have our NDE development environment installed locally)
mit-readme.md:26
- Typo: 'packge' → 'package'. Also consider formatting the view ID as code for consistency/readability.
3. The action's default setting creates a customization packge for the NDE_DEV view, but this can be changed if you want to deploy the customization package to a different Primo view.
mit-readme.md:28
- These list items are missing trailing periods, making punctuation inconsistent across the section.
4. Download the customization package from the Development build action summary in the repo after the action completes
5. Upload the .zip file to the target Primo view via the Alma admin interface following the instructions at https://knowledge.exlibrisgroup.com/Primo/Product_Documentation/020Primo_VE/Primo_VE_(English)/050Display_Configuration/010Configuring_Discovery_Views_for_Primo_VE#Managing_Customization_Packages (Requires user with write access to Discovery Configuration in Alma)
mit-readme.md:32
- The sentence reads as incomplete ("...production view (
NDE)STAGE") and is missing terminal punctuation; clarify thatSTAGEis the name of the cloned view.
In order to test changes against the most production-like environment, it is recommended to create a short-lived clone of the production view (`NDE`) `STAGE`
mit-readme.md:37
- Step 5 is missing a trailing period (and step 4 has trailing whitespace).
4. Download the customization package from the Stage build action summary in the GitHub repo.
5. Upload the .zip file to the `STAGE` view via the Alma admin interface following the instructions at https://knowledge.exlibrisgroup.com/Primo/Product_Documentation/020Primo_VE/Primo_VE_(English)/050Display_Configuration/010Configuring_Discovery_Views_for_Primo_VE#Managing_Customization_Packages (Requires user with write access to Discovery Configuration in Alma)
mit-readme.md:43
- Step 3 is missing a trailing period, making punctuation inconsistent with steps 1–2.
3. Deploy the .zip file to production `NDE` view via the Alma admin interface following the instructions at https://knowledge.exlibrisgroup.com/Primo/Product_Documentation/020Primo_VE/Primo_VE_(English)/050Display_Configuration/010Configuring_Discovery_Views_for_Primo_VE#Managing_Customization_Packages (Requires user with write access to Discovery Configuration in Alma)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
djanelle-mit
left a comment
There was a problem hiding this comment.
The parts I'm familiar make sense! Naturally I don't have access to Alma to make the build changes, so not sure if there's another reviewer to tag in for this, but having accurate documentation is a huge win!
Question: are there any key environment variables or settings that we've added to our config files that a person cloning the repo wouldn't get that we should add to the docs?
Either way, this looks good to me, the question above isn't a blocker.
Why these changes are being introduced:
How this addresses that need:
Side effects of this change:
none
Relevant ticket(s):