docs: move reference into its own chapter #382
Conversation
WalkthroughThis update introduces numerous changes, including Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range and nitpick comments (1)
docs/content/configuration/variables.md (1)
523-523: Fix typographical issue.Consider using the Oxford spelling "parametrization".
- parametrisation + parametrizationTools
LanguageTool
[style] ~523-~523: Would you like to use the Oxford spelling “parametrization”? The spelling ‘parametrisation’ is also correct.
Context: ...}}) where$variablestyle is used for parametrisation and the profile [config flag]({{% relre...(OXFORD_SPELLING_Z_NOT_S)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (20)
- .gitignore (1 hunks)
- commands.go (2 hunks)
- commands_display.go (1 hunks)
- commands_generate.go (1 hunks)
- contrib/templates/_config-reference.gomd (1 hunks)
- contrib/templates/global.gomd (1 hunks)
- contrib/templates/groups.gomd (1 hunks)
- contrib/templates/json-schema.gomd (1 hunks)
- contrib/templates/nested.gomd (1 hunks)
- contrib/templates/profile.gomd (1 hunks)
- contrib/templates/profile.nested-section.gomd (1 hunks)
- contrib/templates/profile.sub-section.gomd (1 hunks)
- contrib/templates/reference.gomd (1 hunks)
- contrib/templates/value-types.gomd (1 hunks)
- docs/content/_index.md (1 hunks)
- docs/content/configuration/jsonschema/index.md (1 hunks)
- docs/content/configuration/variables.md (1 hunks)
- docs/content/contributions/_index.md (1 hunks)
- docs/content/schedules/_index.md (1 hunks)
- docs/themes/hugo-theme-relearn (1 hunks)
Files skipped from review due to trivial changes (9)
- .gitignore
- contrib/templates/global.gomd
- contrib/templates/nested.gomd
- contrib/templates/reference.gomd
- contrib/templates/value-types.gomd
- docs/content/_index.md
- docs/content/contributions/_index.md
- docs/content/schedules/_index.md
- docs/themes/hugo-theme-relearn
Additional context used
LanguageTool
docs/content/configuration/jsonschema/index.md
[grammar] ~19-~19: Did you mean “setting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ... known restic versions and may allow to set flags that are not supported by a parti...(ALLOW_TO)
docs/content/configuration/variables.md
[style] ~523-~523: Would you like to use the Oxford spelling “parametrization”? The spelling ‘parametrisation’ is also correct.
Context: ...}}) where$variablestyle is used for parametrisation and the profile [config flag]({{% relre...(OXFORD_SPELLING_Z_NOT_S)
Additional comments not posted (30)
contrib/templates/profile.nested-section.gomd (1)
1-38: LGTM!The template is well-structured and follows good practices for maintainability and readability.
contrib/templates/groups.gomd (1)
1-38: LGTM!The template is well-structured and follows good practices for maintainability and readability.
contrib/templates/json-schema.gomd (1)
1-48: LGTM!The template is well-structured and follows good practices for maintainability and readability.
contrib/templates/profile.sub-section.gomd (3)
27-39: LGTM!The section profile and description logic are correctly implemented.
43-56: LGTM!The flags and properties logic are correctly implemented.
60-63: LGTM!The layout hint for overriding flags is correctly implemented.
contrib/templates/profile.gomd (3)
29-39: LGTM!The profile section and description logic are correctly implemented.
43-56: LGTM!The flags and properties logic are correctly implemented.
58-61: LGTM!The layout notice for restic command flags is correctly implemented.
contrib/templates/_config-reference.gomd (5)
1-25: LGTM!The template header and partial templates declaration are correctly implemented.
26-35: LGTM!The cell and range printing templates are correctly implemented.
37-79: LGTM!The property type printing template is correctly implemented.
81-100: LGTM!The property table and row printing templates are correctly implemented.
102-138: LGTM!The property description printing template is correctly implemented.
commands_generate.go (5)
27-53: LGTM!The
generateCommandfunction is correctly implemented with the new parameterctx.
58-135: LGTM!The
generateConfigReferencefunction is correctly implemented.
138-155: LGTM!The
generatePagefunction is correctly implemented.
157-173: LGTM!The
generateJsonSchemafunction is correctly implemented.
175-180: LGTM!The
SectionInfoDatatype is correctly implemented.commands_display.go (1)
325-332: LGTM!The
sortedProfileKeysfunction is implemented correctly and follows best practices.commands.go (10)
12-18: LGTM!The
initfunction correctly registers own commands and excludes profile sections.
Line range hint
20-232:
LGTM!The
getOwnCommandsfunction correctly defines and returns a list of own commands.
Line range hint
234-236:
LGTM!The
panicCommandfunction is implemented correctly.
Line range hint
238-261:
LGTM!The
completeCommandfunction is implemented correctly and handles different requesters.
Line range hint
263-312:
LGTM!The
showProfilefunction correctly displays the profile information and schedules.
Line range hint
314-324:
LGTM!The
showSchedulesfunction correctly displays the schedules.
Line range hint
370-389:
LGTM!The
randomKeyfunction correctly generates and displays a random key.
Line range hint
391-409:
LGTM!The
selectProfilesfunction correctly selects profiles based on flags and arguments.
Line range hint
411-415:
LGTM!The
flagsForProfilefunction correctly returns a copy of flags with the profile name set.
Line range hint
417-471:
LGTM!The
createSchedulefunction correctly creates and schedules jobs based on the configuration and flags.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- Makefile (3 hunks)
- commands_generate.go (1 hunks)
- docs/content/configuration/jsonschema/index.md (1 hunks)
Files skipped from review due to trivial changes (1)
- Makefile
Files skipped from review as they are similar to previous changes (2)
- commands_generate.go
- docs/content/configuration/jsonschema/index.md
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #382 +/- ##
==========================================
- Coverage 72.33% 71.52% -0.81%
==========================================
Files 113 122 +9
Lines 10555 12801 +2246
==========================================
+ Hits 7634 9155 +1521
- Misses 2518 3230 +712
- Partials 403 416 +13
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- .github/workflows/doc.yml (1 hunks)
- .github/workflows/release-doc.yml (2 hunks)
- Makefile (2 hunks)
- commands_test.go (1 hunks)
- docs/content/contributions/_index.md (2 hunks)
- docs/hugo.toml (1 hunks)
Files skipped from review due to trivial changes (4)
- .github/workflows/doc.yml
- .github/workflows/release-doc.yml
- Makefile
- commands_test.go
Files skipped from review as they are similar to previous changes (1)
- docs/content/contributions/_index.md
Additional comments not posted (1)
docs/hugo.toml (1)
17-17: LGTM! The addition ofordersectionsbyis appropriate.The
ordersectionsbyparameter will help in organising the sections by weight, which aligns with the objective of improving the structure of the documentation.
Move the reference documentation into its own chapter (with sub-sections)
Fixes #380