Updated maintenance docs to split in 3 parts. #2271
Merged
Conversation
This file contains hidden or 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
WalkthroughThe PR reorganizes maintenance documentation by consolidating script and test guidelines into an expanded template maintenance page, introducing a new installer documentation file, restructuring the contributing sidebar with explicit document ordering, and adding redirects. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @.vortex/docs/content/contributing/maintenance/installer.mdx:
- Around line 105-110: Change the phrase "a hundred plus installation
permutations" to the hyphenated compound modifier "a hundred-plus installation
permutations" in the sentence that begins "For every test permutation, the
installer initiates a fresh project..." so the compound modifier is correctly
hyphenated.
In @.vortex/docs/content/contributing/maintenance/template.mdx:
- Around line 61-83: Fix typos and wording in the requirements list: change
"early exist" to "early exit" in item 7, normalize "I.e.," occurrences to
"i.e.," for examples (items 13 and 15), change "3-rd" to "3rd" in item 14, and
ensure punctuation and spacing are consistent around code examples (e.g., a
space after commas and before i.e./e.g. where used); update any affected phrases
that reference examples like VORTEX_NOTIFY_REF, command -v curl, info, pass,
VORTEX_ prefix, and VORTEX_NOTIFY_ to match those corrected words.
Comment on lines
+105
to
+110
| For every test permutation, the installer *initiates a fresh project* from the | ||
| Vortex template with a specific combination of user selections and runs | ||
| assertions against the resulting files. Because a single template change can | ||
| affect a hundred plus installation permutations, snapshot testing makes it easy to | ||
| **review the impact of a change across all scenarios as diffs** — ensuring that | ||
| regressions are caught before they reach consumers. |
There was a problem hiding this comment.
Hyphenate the compound modifier “hundred-plus.”
Minor grammar polish.
✅ Proposed fix
- affect a hundred plus installation permutations, snapshot testing makes it easy to
+ affect a hundred-plus installation permutations, snapshot testing makes it easy to📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| For every test permutation, the installer *initiates a fresh project* from the | |
| Vortex template with a specific combination of user selections and runs | |
| assertions against the resulting files. Because a single template change can | |
| affect a hundred plus installation permutations, snapshot testing makes it easy to | |
| **review the impact of a change across all scenarios as diffs** — ensuring that | |
| regressions are caught before they reach consumers. | |
| For every test permutation, the installer *initiates a fresh project* from the | |
| Vortex template with a specific combination of user selections and runs | |
| assertions against the resulting files. Because a single template change can | |
| affect a hundred-plus installation permutations, snapshot testing makes it easy to | |
| **review the impact of a change across all scenarios as diffs** — ensuring that | |
| regressions are caught before they reach consumers. |
🧰 Tools
🪛 LanguageTool
[grammar] ~108-~108: Use a hyphen to join words.
Context: ...gle template change can affect a hundred plus installation permutations, snapshot...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In @.vortex/docs/content/contributing/maintenance/installer.mdx around lines 105
- 110, Change the phrase "a hundred plus installation permutations" to the
hyphenated compound modifier "a hundred-plus installation permutations" in the
sentence that begins "For every test permutation, the installer initiates a
fresh project..." so the compound modifier is correctly hyphenated.
Comment on lines
+61
to
+83
| 7. SHOULD include variable values checks with errors and early exist, i.e.: | ||
| ```shell | ||
| [ -z "${VORTEX_NOTIFY_REF}" ] && fail "Missing required value for VORTEX_NOTIFY_REF" && exit 1 | ||
| ``` | ||
| 8. SHOULD include binaries checks if the script relies on them, i.e.: | ||
| ```shell | ||
| command -v curl > /dev/null || ( fail "curl command is not available." && exit 1 ) | ||
| ``` | ||
| 9. MUST contain an `info` message about the start of the script body, e.g.: | ||
| ```shell | ||
| info "Started GitHub notification for operation ${VORTEX_NOTIFY_EVENT}" | ||
| ``` | ||
| 10. MUST contain an `pass` message about the finish of the script body, e.g.: | ||
| ```shell | ||
| pass "Finished GitHub notification for operation ${VORTEX_NOTIFY_EVENT}" | ||
| ``` | ||
| 11. MUST use uppercase global variables | ||
| 12. MUST use lowercase local variables. | ||
| 13. MUST use long options instead of short options for readability. I.e., `drush cache:rebuild` instead of `drush cr`. | ||
| 14. MUST use `VORTEX_` prefix for variables, unless it is a known 3-rd party | ||
| variable like `PACKAGE_TOKEN` or `COMPOSER`. | ||
| 15. MUST use script-specific prefix. I.e., for `notify.sh`, the variable to skip | ||
| notifications should start with `VORTEX_NOTIFY_`. |
There was a problem hiding this comment.
Fix a few typos in the requirements list.
Small wording corrections to avoid reader confusion.
✅ Proposed fix
-7. SHOULD include variable values checks with errors and early exist, i.e.:
+7. SHOULD include variable value checks with errors and early exit, i.e.:
-10. MUST contain an `pass` message about the finish of the script body, e.g.:
+10. MUST contain a `pass` message about the finish of the script body, e.g.:
-14. MUST use `VORTEX_` prefix for variables, unless it is a known 3-rd party
+14. MUST use `VORTEX_` prefix for variables, unless it is a known 3rd-party📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| 7. SHOULD include variable values checks with errors and early exist, i.e.: | |
| ```shell | |
| [ -z "${VORTEX_NOTIFY_REF}" ] && fail "Missing required value for VORTEX_NOTIFY_REF" && exit 1 | |
| ``` | |
| 8. SHOULD include binaries checks if the script relies on them, i.e.: | |
| ```shell | |
| command -v curl > /dev/null || ( fail "curl command is not available." && exit 1 ) | |
| ``` | |
| 9. MUST contain an `info` message about the start of the script body, e.g.: | |
| ```shell | |
| info "Started GitHub notification for operation ${VORTEX_NOTIFY_EVENT}" | |
| ``` | |
| 10. MUST contain an `pass` message about the finish of the script body, e.g.: | |
| ```shell | |
| pass "Finished GitHub notification for operation ${VORTEX_NOTIFY_EVENT}" | |
| ``` | |
| 11. MUST use uppercase global variables | |
| 12. MUST use lowercase local variables. | |
| 13. MUST use long options instead of short options for readability. I.e., `drush cache:rebuild` instead of `drush cr`. | |
| 14. MUST use `VORTEX_` prefix for variables, unless it is a known 3-rd party | |
| variable like `PACKAGE_TOKEN` or `COMPOSER`. | |
| 15. MUST use script-specific prefix. I.e., for `notify.sh`, the variable to skip | |
| notifications should start with `VORTEX_NOTIFY_`. | |
| 7. SHOULD include variable value checks with errors and early exit, i.e.: |
🤖 Prompt for AI Agents
In @.vortex/docs/content/contributing/maintenance/template.mdx around lines 61 -
83, Fix typos and wording in the requirements list: change "early exist" to
"early exit" in item 7, normalize "I.e.," occurrences to "i.e.," for examples
(items 13 and 15), change "3-rd" to "3rd" in item 14, and ensure punctuation and
spacing are consistent around code examples (e.g., a space after commas and
before i.e./e.g. where used); update any affected phrases that reference
examples like VORTEX_NOTIFY_REF, command -v curl, info, pass, VORTEX_ prefix,
and VORTEX_NOTIFY_ to match those corrected words.
|
Member
Author
|
Member
Author
|
Member
Author
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2271 +/- ##
==========================================
- Coverage 77.07% 76.46% -0.61%
==========================================
Files 114 107 -7
Lines 5993 5834 -159
Branches 44 0 -44
==========================================
- Hits 4619 4461 -158
+ Misses 1374 1373 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary by CodeRabbit
New Features
Documentation