Commit Graph

9 Commits

Author SHA1 Message Date
Jonas L cc28293150
chore: reenable vale rule after fix (#2965)
Fixes #2957
2024-03-02 14:15:50 +01:00
Kyle Robbertze bace9ed917 ci: disable overly-sensitive vale rule 2024-02-19 08:27:23 +00:00
jo d2709dc6d3 docs: only use microsoft styling guide 2023-04-12 16:50:04 +01:00
jo 8ba62079f5 docs: ignore range format during docs linting 2023-04-12 16:50:04 +01:00
jo 50809a933c docs: fix vale linting errors
- are not > aren't
- auto-_ > auto _
- avoid backend
- cannot > can't
- do not > don't
- does not > doesn't
- ignore emoji code
- has not > hasn't
- ignore Microsoft.GeneralURL
- is not > isn't
- it is > it's
- no exclamation point
- put code inside code blocks
- put commit sha inside code blocks
- put exception message in code blocks
- remove slang
- should not > shouldn't
- they are > they're
- we are > we're
- will not > won't
2022-09-26 09:13:25 +02:00
jo 855cf83325 chore: ignore emoji shortcodes in vale linting 2022-09-26 09:13:25 +02:00
jo 31e09401bb chore: replace custom makefile with vale packages 2022-09-22 13:19:35 +02:00
Jonas L 3ec85d7821
docs: update structure and create links between pages (#1611)
* docs: rework files structure

* rewrite documentation entrypoint

* update category files and use yml

* add manuals entry page

* update admin-manual titles and page order

* create releases sections

* move ssl configuration to reverse proxy

* docs: update website vars and links

* update release note codeblock syntax key

* resurect troubleshooting guide

* Update freeipa custom auth documentation

* add notice about the state of the documentation

* update the backup documentation

* tmp: allow to deploy the website for preview

* Don't use require.resolve for plugins

* Update the main page link dest

* update development environment title

* rewrite the install/upgrade/migrate as guides

* update website docs sections links

* Fix urls

* move release note to documentation

* move home links to vars files

* tmp: update deploy url

* add react to tsconfig to handle jsx linting

* fix: replace absolute url to relative path to files

* tmp: allow CI Website dpeloy on working branch

* Update release note title

* use default syntax highlighting theme

* update the troubleshooting guide

* Wording

* use CodeBlock components

* Better prose

* remove api_client config section

* fix prose errors

* update import prefix for vars file

* reroder docs manuals links

* use sentence capitalization for page titles

* Wording

* missing word

* Update note about syslog log file

* wording
2022-02-21 09:16:54 +02:00
jo 75e3760f2e ci: setup docs prose linting with vale
- only deploy if prose lint passes
- rework styles download
- add vale anotations matcher
- set MinAlertLevel to warning
- add website pages to the prose linter
- do not fail on docs linting
2022-02-11 10:12:07 +01:00