From a7052162a7447bf0ec2b1c5929de3e17103b2db9 Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Wed, 3 Jan 2024 12:50:00 -0600 Subject: [PATCH 1/3] # Add introduction page with basic linter information to localdocs --- docs/guides/contribute/localdocs/.pages | 1 + docs/guides/contribute/localdocs/index.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 docs/guides/contribute/localdocs/index.md diff --git a/docs/guides/contribute/localdocs/.pages b/docs/guides/contribute/localdocs/.pages index e407410550..63cc822bbf 100644 --- a/docs/guides/contribute/localdocs/.pages +++ b/docs/guides/contribute/localdocs/.pages @@ -1,5 +1,6 @@ --- nav: + - ... | index*.md - ... | rockydocs_web_dev*.md - ... | mkdocs_lsyncd*.md - ... | rockydocs_webdev_v2*.md diff --git a/docs/guides/contribute/localdocs/index.md b/docs/guides/contribute/localdocs/index.md new file mode 100644 index 0000000000..19974ae066 --- /dev/null +++ b/docs/guides/contribute/localdocs/index.md @@ -0,0 +1,13 @@ +--- +Title: Introduction +author: Steven Spencer +contributors: +tags: + - local docs + - docs as code + - linters +--- + +# Introduction + +Using a local copy of the Rocky Linux documentation is helpful for those who contribute often and need to see exactly how a document will look in the web interface after merging. From 7723db94c697dad6dcfbdb435cc4538e484ff2b6 Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Wed, 3 Jan 2024 12:50:31 -0600 Subject: [PATCH 2/3] Forgot to save... --- docs/guides/contribute/localdocs/index.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/guides/contribute/localdocs/index.md b/docs/guides/contribute/localdocs/index.md index 19974ae066..bf76376c85 100644 --- a/docs/guides/contribute/localdocs/index.md +++ b/docs/guides/contribute/localdocs/index.md @@ -8,6 +8,16 @@ tags: - linters --- -# Introduction +# Introduction -Using a local copy of the Rocky Linux documentation is helpful for those who contribute often and need to see exactly how a document will look in the web interface after merging. +Using a local copy of Rocky Linux documentation is helpful for those who contribute often and need to see exactly how a document will look in the web interface after merging. The methods included here represent contributors preferences to date. + +Using a local copy of the documentation is one step in the development process for those who subscribe to the philosophy of "docs as code," a workflow for documentation that is similar to code development. + +## Markdown linting + +In addition to environments for storing and building the documentation, a consideration for some writers might be a linter for markdown. Markdown linters are helpful in many aspects of writing documents, including checks for grammar, spelling, formatting, and more. Sometimes these are separate tools or plugins for your editor. One such tool is [markdownlint](https://github.com/DavidAnson/markdownlint), a Node.js tool. `markdownlint` is available as plugin for many popular editors including Visual Studio Code and NVChad. For this reason, a `.markdownlint.yml` file is including in the root of the documentation directory that will apply the rules available and enabled for the project. `markdownlint` is purely a formatting linter. It will check for errant spaces, in-line html elements, double blank lines, incorrect tabs, and more. For grammar, spelling, inclusive language usage, and more, install other tools. + +!!! info "Disclaimer" + + None of the items in this category ("Local documentation") are required to write documents and submit them for approval. They exist for those who want to follow [docs as code](https://www.writethedocs.org/guide/docs-as-code/) philosophies, which include at minimum a local copy of the documentation. From e98f9849430d7e5ac05093e2ef23d224275a3465 Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Thu, 4 Jan 2024 09:29:26 -0600 Subject: [PATCH 3/3] fix wrong tense of word --- docs/guides/contribute/localdocs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/contribute/localdocs/index.md b/docs/guides/contribute/localdocs/index.md index bf76376c85..4408b1bcf5 100644 --- a/docs/guides/contribute/localdocs/index.md +++ b/docs/guides/contribute/localdocs/index.md @@ -16,7 +16,7 @@ Using a local copy of the documentation is one step in the development process f ## Markdown linting -In addition to environments for storing and building the documentation, a consideration for some writers might be a linter for markdown. Markdown linters are helpful in many aspects of writing documents, including checks for grammar, spelling, formatting, and more. Sometimes these are separate tools or plugins for your editor. One such tool is [markdownlint](https://github.com/DavidAnson/markdownlint), a Node.js tool. `markdownlint` is available as plugin for many popular editors including Visual Studio Code and NVChad. For this reason, a `.markdownlint.yml` file is including in the root of the documentation directory that will apply the rules available and enabled for the project. `markdownlint` is purely a formatting linter. It will check for errant spaces, in-line html elements, double blank lines, incorrect tabs, and more. For grammar, spelling, inclusive language usage, and more, install other tools. +In addition to environments for storing and building the documentation, a consideration for some writers might be a linter for markdown. Markdown linters are helpful in many aspects of writing documents, including checks for grammar, spelling, formatting, and more. Sometimes these are separate tools or plugins for your editor. One such tool is [markdownlint](https://github.com/DavidAnson/markdownlint), a Node.js tool. `markdownlint` is available as plugin for many popular editors including Visual Studio Code and NVChad. For this reason, included in the root of the documentation directory is a `.markdownlint.yml` file that will apply the rules available and enabled for the project. `markdownlint` is purely a formatting linter. It will check for errant spaces, in-line html elements, double blank lines, incorrect tabs, and more. For grammar, spelling, inclusive language usage, and more, install other tools. !!! info "Disclaimer"