Conversation
creativeprojects
commented
Feb 28, 2025
creativeprojects
commented
- Preparation work for adding versioning to the documentation
- Rephrasing some pages
- Add release notes
WalkthroughThis pull request updates the checkdoc command across GitHub Actions workflows and the Makefile by adding the Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant C as CheckDoc
participant FS as File System
U->>C: Run checkdoc with "-i changelog.md"
C->>C: Parse flags and store ignoreFiles=["changelog.md"]
C->>FS: Walk through documentation files
loop For each file
FS-->>C: Return file path
alt File matches ignore pattern
C->>C: Log and skip processing
else
C->>C: Process file for configuration checks
end
end
sequenceDiagram
participant U as User/System
participant B as Backup Process
participant HTTP as Health Check Endpoint
U->>B: Initialise backup with "with-env" configuration
B->>HTTP: Send pre-backup POST request (send-before)
HTTP-->>B: Respond to pre-backup check
B->>B: Execute backup operations
B->>HTTP: Send post-backup POST request (send-after)
HTTP-->>B: Respond to post-backup check
Possibly related PRs
Suggested labels
✨ Finishing Touches
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 0
🧹 Nitpick comments (2)
docs/content/configuration/getting_started/index.md (2)
16-20: Emphasis Styling for File Extensions
Static analysis (MD049) highlights that underscores are used for emphasis (e.g._.toml_) when asterisks are expected. For consistency with project guidelines and to avoid markdownlint warnings, consider replacing underscores with asterisks for the file extensions in these bullet points.Proposed diff:
-* [TOML](https://github.com/toml-lang/toml): configuration file with extension _.toml_ or _.conf_ +* [TOML](https://github.com/toml-lang/toml): configuration file with extension *toml* or *conf* -* [YAML](https://en.wikipedia.org/wiki/YAML): configuration file with extension _.yaml_ +* [YAML](https://en.wikipedia.org/wiki/YAML): configuration file with extension *yaml* -* [JSON](https://en.wikipedia.org/wiki/JSON): configuration file with extension _.json_ +* [JSON](https://en.wikipedia.org/wiki/JSON): configuration file with extension *json*🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
18-18: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
18-18: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
19-19: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
19-19: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
20-20: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
20-20: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
56-58: Adjust Nested List Indentation
Markdownlint (MD007) recommends that nested list items be indented by 2 spaces rather than 4. Adjusting the indentation for the sub-bullets (lines 56–58) will ensure adherence to the style guidelines.Proposed diff:
- * files to include in a backup (`source` flag) - * when to back them up (details later) - * other restic flags for the command line (e.g., `verbose`) + * files to include in a backup (`source` flag) + * when to back them up (details later) + * other restic flags for the command line (e.g., `verbose`)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
56-56: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
.github/workflows/doc.yml(1 hunks).github/workflows/release-doc.yml(1 hunks)Makefile(1 hunks)config/checkdoc/main.go(2 hunks)docs/content/_index.md(1 hunks)docs/content/changelog.md(1 hunks)docs/content/configuration/getting_started/index.md(2 hunks)docs/content/schedules/task_scheduler/index.md(2 hunks)docs/hugo.toml(2 hunks)docs/layouts/shortcodes/pageversions.html(1 hunks)docs/version.toml(1 hunks)examples/dev.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/version.toml
🧰 Additional context used
🪛 LanguageTool
docs/content/_index.md
[grammar] ~22-~22: The correct preposition appears to be “on”.
Context: ...indows, nice in Unix, and/or ionice in Linux) * Check for [enough memory]({{% ...
(IN_WINDOWS)
docs/content/changelog.md
[typographical] ~28-~28: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...) ## 🧙🏻♀️ Halloween edition 🎃 - Finally a long standing bug was fixed in this v...
(RB_LY_COMMA)
[misspelling] ~28-~28: This word is normally spelled with a hyphen.
Context: ...♀️ Halloween edition 🎃 - Finally a long standing bug was fixed in this version: use prop...
(EN_COMPOUNDS_LONG_STANDING)
[uncategorized] ~29-~29: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ... values on systemd scheduled tasks. - Also the last chunk of work for the configur...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...r v1 and v2 configuration - Another long standing bug on Windows: escape configuration fi...
(EN_COMPOUNDS_LONG_STANDING)
[uncategorized] ~36-~36: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...02d6e75d7684a40abf) Global json schema (auto versioning) (#412) * [2a34ea7...
(AUTO_HYPHEN)
[typographical] ~101-~101: It seems that one or two commas are missing.
Context: ...ion log file (prefixed with temp:/t/) Thanks @iluvatyr for the quick bug report 👍🏻 ## Changelo...
(THANKS_COMMA)
[style] ~120-~120: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...isphere! A new release is here too! 🎉 A lot of goodies in this release: ### new run-s...
(A_LOT_OF)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a space.
Context: ...crond schedules. Now you can directly setup a crontab file no matter which tool i...
(NOUN_VERB_CONFUSION)
[typographical] ~133-~133: Consider adding a comma here.
Context: ... you can directly setup a crontab file no matter which tool is going to consume i...
(NO_MATTER_COMMA)
[grammar] ~179-~179: The correct preposition appears to be “on”.
Context: ...f5dc5) fix remaining unit tests failing in Windows (#360) * [3b8613e](https://gith...
(IN_WINDOWS)
[grammar] ~186-~186: The operating system from Apple is written “macOS”.
Context: .../commit/e93874d) build with go 1.22 and macOs arm64 (#317) * [e6eed3d](https://github...
(MAC_OS)
[style] ~197-~197: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...ond time lucky February release 🚀 🆕 A lot of pre-built binaries have been added on t...
(A_LOT_OF)
[uncategorized] ~198-~198: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...re-built binaries provided by restic Otherwise this is mostly a maintenance release wi...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~224-~224: Did you mean: “By default,”?
Context: ... metrics to the proxy using protobuf. By default it's now using the more widely used `te...
(BY_DEFAULT_COMMA)
[style] ~227-~227: Consider an alternative verb to strengthen your wording.
Context: ...more widely used text format. If you have any issue sending metrics to your proxy...
(IF_YOU_HAVE_THIS_PROBLEM)
[grammar] ~256-~256: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ofile/commit/1b3292c) logging: allow to setup default log output in global (#277) * [...
(NOUN_VERB_CONFUSION)
[uncategorized] ~270-~270: When a person is directly addressed, a comma should set off the name.
Context: ...tps://scoop.sh/#/apps?q=resticprofile)! thanks @hgraeber - detect if the host is runn...
(MISSING_COMMA_WITH_NNP)
[grammar] ~289-~289: Possible agreement error. The noun ‘regression’ seems to be countable; consider using: “few regressions”.
Context: ...dition 🌻 This release mostly fixes a few regression from version 0.21.0 and adds a handful ...
(MANY_NN)
[grammar] ~312-~312: Did you mean “escaping”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...rofile/commit/3476fbc) Variables: Allow to escape "$" with "$$" (#216) # v0.22.0 (2023...
(ALLOW_TO)
[style] ~321-~321: Consider using just “revert”.
Context: ...mmand`. But don't worry: you can easily revert back to the original value by adding this op...
(RETURN_BACK)
[typographical] ~343-~343: It seems that one or two commas are missing.
Context: ...some flag (repository and others...) Thanks @jkellerer for the quick fixes 😉 👍🏻 ## New featur...
(THANKS_COMMA)
[style] ~347-~347: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ur version of restic will be generated (prior to this version, any flag like `unknown-fl...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~348-~348: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...stic command line as --unknown-flag. Also this version generates a JSON schema: t...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[typographical] ~349-~349: It seems that one or two commas are missing.
Context: ...OML and YAML configuration file format. Thanks @jkellerer for the awesome work on this 🎉 . [More inf...
(THANKS_COMMA)
[style] ~349-~349: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ... file format. Thanks @jkellerer for the awesome work on this 🎉 . [More information her...
(AWESOME)
[uncategorized] ~351-~351: Possible missing comma found.
Context: ...ature is the introduction of the help command which works for both all the **resticpr...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~364-~364: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ur version of restic will be generated (prior to this version, any flag like `unknown-fl...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~365-~365: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...stic command line as --unknown-flag. Also this version generates a JSON schema: t...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[typographical] ~366-~366: It seems that one or two commas are missing.
Context: ...OML and YAML configuration file format. Thanks @jkellerer for the awesome work on this 🎉 . [More inf...
(THANKS_COMMA)
[style] ~366-~366: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ... file format. Thanks @jkellerer for the awesome work on this 🎉 . [More information her...
(AWESOME)
[uncategorized] ~368-~368: Possible missing comma found.
Context: ...ature is the introduction of the help command which works for both all the **resticpr...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~370-~370: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...s and flags. Try it out! And as usual, a lot of bug fixes 😉 ## Changelog * [683bf78]...
(A_LOT_OF)
[uncategorized] ~374-~374: The correct spelling defined by the Internet Assigned Numbers Authority (IANA) is “UTF-16” or “utf-16”.
Context: ...ommit/74b0c46) Allow config encoding in UTF16 and ISO88591 * [d6a51ad](https://github...
(UTF_8_HYPHEN)
[uncategorized] ~410-~410: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...-after-failandrun-finallytargets. Also more targets are now available forbac...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~449-~449: Would you like to use the Oxford spelling “Initialize”? The spelling ‘Initialise’ is also correct.
Context: ...eprojects/resticprofile/commit/2ed3045) Initialise copy repository using --copy-chunker-pa...
(OXFORD_SPELLING_Z_NOT_S)
[typographical] ~466-~466: It seems that one or two commas are missing.
Context: ...lowing the use of [profile].[command] - Thanks @Syphdias for the PR #89 - shell completion (for `ba...
(THANKS_COMMA)
[typographical] ~467-~467: It seems that one or two commas are missing.
Context: ...sed by zsh with bash compatibility) - Thanks @jkellerer for the PR #90 - run a shell command to us...
(THANKS_COMMA)
[typographical] ~468-~468: It seems that one or two commas are missing.
Context: ...e as a stdin input (like mysqldump) - Thanks @jkellerer for the PR #98 - run a shell command in th...
(THANKS_COMMA)
[misspelling] ~469-~469: This expression is normally spelled as one or with a hyphen.
Context: ... a shell command in the background when non fatal errors are detected from restic - Thank...
(EN_COMPOUNDS_NON_FATAL)
[typographical] ~469-~469: It seems that one or two commas are missing.
Context: ...fatal errors are detected from restic - Thanks @jkellerer for the PR #99 and a lot of bug fixes 👍?...
(THANKS_COMMA)
[style] ~471-~471: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ... Thanks @jkellerer for the PR #99 and a lot of bug fixes 👍🏻 ## Changelog * [83e423...
(A_LOT_OF)
[duplication] ~474-~474: Possible typo: you repeated a word.
Context: ...ticprofile/commit/83e423e) Add run flag to to be able to have profile and job name as...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~541-~541: Consider using a different verb for a more formal wording.
Context: ...1-08-29) ##
(FIX_RESOLVE)
[typographical] ~543-~543: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...pace, *, ?, `, [, ', ". If for some reason the fix broke your configuration, there...
(FOR_WHATEVER_REASON_COMMA)
[style] ~543-~543: Consider using just “revert”.
Context: ...can activate in the global section to revert back to the broken implementation: ```yaml ...
(RETURN_BACK)
[uncategorized] ~588-~588: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ied a path in the global configuration and it cannot find the file, a warning will...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~643-~643: Do not mix variants of the same word (‘initialize’ and ‘initialise’) within a single text.
Context: ...13.0: a message was sent to stderr when initialize parameter was set and the repository a...
(EN_WORD_COHERENCY)
[uncategorized] ~648-~648: Do not mix variants of the same word (‘initialize’ and ‘initialise’) within a single text.
Context: ...sage was sent to stderr when parameter initialize=true and repo exists ## Docker images...
(EN_WORD_COHERENCY)
[uncategorized] ~660-~660: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sful when restic produced a new snapshot but some files were missing (https://github...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~691-~691: Consider using a different verb for a more formal wording.
Context: ...eprojects/resticprofile/commit/01ae05a) fix an issue where status --all was stoppin...
(FIX_RESOLVE)
[grammar] ~710-~710: The operating system from Apple is written “macOS”
Context: ...* - add support for background tasks on Mac OS via a new schedule-priority parameter...
(MAC_OS)
[misspelling] ~733-~733: This word is normally spelled as one.
Context: ...it/a19f124) move other-flags before the sub-sections * [967c4a8](https://github.com/creative...
(EN_COMPOUNDS_SUB_SECTIONS)
[style] ~822-~822: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...s-file # v0.9.0 (2020-07-29) A few new big features in this release: - add `--dry-...
(EN_ADJ_ORDER)
[grammar] ~931-~931: A verb may be missing.
Context: ...ocumentation # v0.7.1 (2020-06-25) This a maintenance release: - add a new para...
(THIS_MISSING_VERB)
[grammar] ~941-~941: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...9ca91d0) fix self-update not working on windows * [d32c172](https://github.com/creative...
(A_WINDOWS)
[grammar] ~974-~974: The operating system from Apple is written “macOS”
Context: .../commit/713e429) Add .tar.gz binary for mac os * [4c4c0d8](https://github.com/creative...
(MAC_OS)
[uncategorized] ~986-~986: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...f resticprofile in go: * I tried python and I wasn't particularly impressed * I tri...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~987-~987: The verb “go” needs to be in the to-infinitive form.
Context: ...and I wasn't particularly impressed * I tried go and I loved it (also that's what all th...
(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~987-~987: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sn't particularly impressed * I tried go and I loved it (also that's what all the co...
(COMMA_COMPOUND_SENTENCE)
🪛 markdownlint-cli2 (0.17.2)
docs/content/_index.md
21-21: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
21-21: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
22-22: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
22-22: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
41-41: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
41-41: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
42-42: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
42-42: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
43-43: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
43-43: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
docs/content/configuration/getting_started/index.md
17-17: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
18-18: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
18-18: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
19-19: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
19-19: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
20-20: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
20-20: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
56-56: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
docs/content/changelog.md
28-28: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
29-29: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
30-30: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
31-31: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
49-49: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
129-129: Bare URL used
null
(MD034, no-bare-urls)
135-135: Bare URL used
null
(MD034, no-bare-urls)
141-141: Bare URL used
null
(MD034, no-bare-urls)
157-157: Bare URL used
null
(MD034, no-bare-urls)
161-161: Bare URL used
null
(MD034, no-bare-urls)
200-200: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
201-201: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
202-202: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
203-203: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
234-234: Bare URL used
null
(MD034, no-bare-urls)
267-267: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
268-268: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
269-269: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
270-270: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
271-271: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
272-272: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
327-327: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
341-341: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
342-342: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
362-362: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
393-393: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
394-394: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
409-409: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
410-410: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
411-411: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
412-412: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
413-413: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
433-433: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
434-434: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
435-435: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
436-436: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
437-437: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
438-438: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
439-439: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
440-440: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
441-441: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
466-466: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
467-467: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
468-468: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
469-469: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
494-494: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
495-495: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
512-512: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
513-513: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
514-514: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
515-515: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
516-516: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
534-534: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
550-550: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
551-551: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
552-552: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
553-553: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
554-554: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
555-555: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
557-557: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
558-558: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
559-559: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
560-560: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
579-579: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
587-587: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
588-588: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
598-598: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
605-605: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
618-618: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
619-619: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
636-636: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
637-637: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
643-643: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
653-653: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
654-654: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
660-660: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
660-660: Bare URL used
null
(MD034, no-bare-urls)
661-661: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
673-673: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
674-674: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
681-681: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
682-682: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
700-700: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
701-701: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
706-706: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
708-708: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
708-708: Bare URL used
null
(MD034, no-bare-urls)
709-709: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
710-710: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
711-711: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
715-715: Bare URL used
null
(MD034, no-bare-urls)
741-741: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
742-742: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
765-765: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
766-766: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
766-766: Spaces inside code span elements
null
(MD038, no-space-in-code)
767-767: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
768-768: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
790-790: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
791-791: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
795-795: Bare URL used
null
(MD034, no-bare-urls)
799-799: Bare URL used
null
(MD034, no-bare-urls)
809-809: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
810-810: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
823-823: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
824-824: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
825-825: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
826-826: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
858-858: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
858-858: Bare URL used
null
(MD034, no-bare-urls)
872-872: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
888-888: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
889-889: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
890-890: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
908-908: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
909-909: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
910-910: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
933-933: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
934-934: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
950-950: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
951-951: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
952-952: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
994-994: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
994-994: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
1003-1003: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1004-1004: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1005-1005: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1014-1014: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1015-1015: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1016-1016: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1021-1021: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1022-1022: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1023-1023: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1024-1024: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1025-1025: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1030-1030: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1035-1035: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1036-1036: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (23)
docs/layouts/shortcodes/pageversions.html (1)
1-9: Looks good - clean implementation of page versions navigationThis shortcode provides a structured way for users to navigate between different versions of the same documentation page, which aligns well with the PR objective of preparing for documentation versioning.
Makefile (1)
295-295: Good addition to ignore changelog when checking docsThe change to add
-i changelog.mdto the checkdoc command ensures that changelog files are excluded from documentation snippet validation, which is appropriate as changelogs often have specific formatting that differs from regular documentation..github/workflows/release-doc.yml (1)
25-25: Consistent documentation checking across environmentsThe addition of
-i changelog.mdto the GitHub Actions workflow ensures that documentation validation behaves consistently with the local Makefile command, which is good practice..github/workflows/doc.yml (1)
31-31: Consistent documentation checking across environmentsThis change maintains consistency with the release-doc.yml workflow and the Makefile, ensuring that changelog files are excluded from documentation validation in all environments.
config/checkdoc/main.go (2)
42-47: Well-implemented file ignore functionalityAdding the ability to ignore specific files during documentation checks is a valuable feature, especially for files like changelogs that have different formatting requirements.
73-79: Efficiently implemented file ignoring logicThe implementation correctly checks if any file contains the ignore pattern before processing it. The log message helpfully indicates which files are being skipped.
examples/dev.yaml (1)
349-360: New “with-env” Section for Environment Variables and Backup HooksThe new “with-env” section is well structured. It correctly inherits from the default configuration and clearly defines the
env-filealong with thebackupsub-sections for both thesend-beforeandsend-afterHTTP POST requests. Please ensure that the environment variable placeholders ($VAR1,$VAR2, and${PROFILE_NAME}) match your deployment expectations. Overall, this addition enhances the configuration flexibility for backups.docs/content/schedules/task_scheduler/index.md (3)
12-15: Improved Clarity on Elevated Mode RequirementsThe rephrasing in lines 12–15 makes it much clearer that if a schedule profile has its permission set to
system, resticprofile will automatically restart in elevated mode. The language is more direct and helps to manage user expectations regarding privilege escalation.
20-21: Clear Warning Regarding Developer CertificateThe note on line 20 now explicitly states that the author cannot prevent the certificate issue without purchasing one, and it even invites community suggestions. This transparent approach is beneficial for users who may be affected by this limitation.
26-27: Enhanced Instructions for Starting an Elevated ShellThe step-by-step instructions (lines 26–27) for starting an elevated shell are clear and user-friendly. The formatting of the steps—using a hyphenated list—is consistent with best practice for documentation.
docs/content/changelog.md (1)
1-43: Comprehensive and Well-Formatted ChangelogThe new changelog document is impressive in its level of detail. It provides clear version headings, release dates, descriptive summaries, and direct links to commit references. This documentation will be very useful for users tracking historical changes. One minor suggestion is to double-check punctuation in the release headers and descriptions for consistency with British style.
🧰 Tools
🪛 LanguageTool
[typographical] ~28-~28: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...) ## 🧙🏻♀️ Halloween edition 🎃 - Finally a long standing bug was fixed in this v...(RB_LY_COMMA)
[misspelling] ~28-~28: This word is normally spelled with a hyphen.
Context: ...♀️ Halloween edition 🎃 - Finally a long standing bug was fixed in this version: use prop...(EN_COMPOUNDS_LONG_STANDING)
[uncategorized] ~29-~29: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ... values onsystemdscheduled tasks. - Also the last chunk of work for the configur...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...rv1andv2configuration - Another long standing bug on Windows: escape configuration fi...(EN_COMPOUNDS_LONG_STANDING)
[uncategorized] ~36-~36: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...02d6e75d7684a40abf) Global json schema (auto versioning) (#412) * [2a34ea7...(AUTO_HYPHEN)
🪛 markdownlint-cli2 (0.17.2)
28-28: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
29-29: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
30-30: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
31-31: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
docs/hugo.toml (2)
24-42: New Side Menu Configurations IntegratedThe addition of the new side menu entries under
[[params.sidebarmenus]]for ‘home’, ‘version’, and ‘shortcuts’ is well implemented. The configuration parameters (such asdisableTitle,identifier,main,pageRef, andtype) are clearly defined. This change will enhance the navigational structure of the documentation site.
79-84: New [image] and [link] Sections for Error HandlingThe new sections for
[image]and[link]with theerrorlevel = 'warning'setting provide a concise way to control error reporting for images and links. This additional configuration is a useful enhancement to the theme’s robustness.docs/content/_index.md (3)
9-10: Rephrased Introduction for Enhanced ClarityThe updated introduction now concisely explains that resticprofile bridges the gap between configuration files and restic backups. This rephrasing is both informative and succinct, making it easier for new users to quickly understand the tool’s purpose.
13-28: Streamlined Feature List with Uniform WordingThe bullet-point list detailing the benefits of using resticprofile has been refined considerably. Phrases like “No need to remember…” and “Create multiple profiles…” contribute to a cleaner, more consistent presentation. The information remains comprehensive without unnecessary verbosity. The use of relative links (via Hugo’s
relref) is correctly applied, enhancing maintainability.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: The correct preposition appears to be “on”.
Context: ...indows, nice in Unix, and/or ionice in Linux) * Check for [enough memory]({{% ...(IN_WINDOWS)
🪛 markdownlint-cli2 (0.17.2)
21-21: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
21-21: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
22-22: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
22-22: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
39-43: Clear Description of Supported Configuration FormatsThe final section outlining the supported file formats (TOML, JSON, YAML, HCL) is clear and well presented. The illustrative links to relevant resources improve the overall utility of the documentation.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
40-40: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
41-41: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
41-41: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
42-42: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
42-42: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
43-43: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
43-43: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
docs/content/configuration/getting_started/index.md (7)
8-10: Clear and Concise Introduction
The rephrasing of the introductory statements (lines 8–10) is well done and enhances clarity. The use of emphasis for resticprofile and wrapper is consistent with the intended style.
14-14: Correct Title Case for Section Heading
Changing the heading to "Choose Your Favorite Format" is an improvement that aligns with title casing conventions.
28-32: Enhanced Instructions for Text Editor Configuration
The rephrased text in the "Configure Your Text Editor" section (lines 28–32) is clear and direct. It effectively informs the reader on how to obtain documentation and auto-completion for resticprofile using Visual Studio Code as an example.
36-38: Good Guidance for Installing Extensions
The instructions for installing the Even Better TOML extension in Visual Studio Code (lines 36–38) are clear and practical, offering useful direction to the user.
50-62: Well-Structured Configuration File Examples
The section describing the configuration file (lines 50–62) is both concise and easy to follow. The bullet points clearly outline the components of each profile.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
56-56: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
141-149: Clear Directives for Repository Setup
The guidance on generating a secure password file (line 141) and initializing the repository (line 149) is straightforward and contributes to improved usability of the documentation.
1-375: Overall Documentation Improvements
The rephrasing and formatting updates throughout the document significantly enhance readability and consistency. Please review the minor markdownlint suggestions—specifically the emphasis style in file extension descriptions and the indentation of nested list items—to ensure full compliance with the project’s style guidelines.🧰 Tools
🪛 LanguageTool
[grammar] ~227-~227: The word “backup” is a noun. The verb is spelled with a space.
Context: ... ## Schedule Let's imagine you want to backup your files every day during your lunch ...(NOUN_VERB_CONFUSION)
🪛 markdownlint-cli2 (0.17.2)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
17-17: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
18-18: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
18-18: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
19-19: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
19-19: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
20-20: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
20-20: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
56-56: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
156-156: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
176-176: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
200-200: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
333-333: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
354-354: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
Codecov ReportAttention: Patch coverage is
❌ Your patch status has failed because the patch coverage (0.00%) is below the target coverage (70.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
1 participant
