docs: fix typos and grammar across the v2 documentation - #89
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Corrects misspellings and grammatical errors in the installation guides, user groups, rendering, troubleshooting and developer pages. Content-only changes; no page metadata (front-matter) was modified. Signed-off-by: Léon Avic Simmons <avicennasis@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Fixes typos and grammar errors across the v2 documentation. Content only — no page front-matter was touched.
From the reported list (15 of 17 rows confirmed against live
master)bundle run it all->bundle and run it all;horiztonal->horizontal;It will also distributes->It will also distributeudpates->updates;optionaly->optionally;certifiate->certificate;will not be redirect to HTTPS->redirectedexplicitely->explicitly;preferrable->preferable;great a limiting->great at limitingsupercript->superscript;Allow HTML: Enable HTML tabs in content->tagsAdministrator Area->Administration Area;functionnality->functionalityfile containing to the database password->file containing the database passwordTwo notes on that list:
certifiateis inside a quoted log line. I checkedserver/core/letsencrypt.jsinrequarks/wiki, which logs(LETSENCRYPT) New certificate received successfully: [ COMPLETED ]— so the fix makes the doc match the real output rather than diverging from it.Administrator Areaappears exactly once in the whole repo;Administration Areaappears 17 times, including two lines above it in the same file.Additionally noticed while reviewing (not in the original report)
An comments module adds discussion capabitilies->A comments module adds discussion capabilitiespersistance->persistence;Persistant Volume Claims->Persistent;Postgers PVC Storage Request->Postgres(matching the row above it);## PostgresSQL->## PostgreSQLmentionned->mentionedNagivate->NavigateYou wil need->You will needpreferrably->preferablythe files localed in->the files located inRefer to to the->Refer to thespecic alignment->specific alignmentA reproducable build workflow->A reproducible build workflowDeliberately left alone
There're(9 occurrences repo-wide, includinggroups.md) — that is a consistent authorial voice, not a one-off slip.javascript->JavaScriptintroubleshooting.md— casing preference, and line 68 is a heading whose anchor would change.releases/*.mdarchive (historical release notes) even though it contains several misspellings — rewriting published changelogs seemed out of scope. Happy to send that separately if you want it.date,description, …), since that is synced page metadata.favouriteininstall/awsecs.md(dialect) andressourcesindev/api.md's description.