Skip to content

docs: fix typos and grammar across the v2 documentation - #89

Open
Avicennasis wants to merge 1 commit into
requarks:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix typos and grammar across the v2 documentation#89
Avicennasis wants to merge 1 commit into
requarks:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

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)

  • install/awsecs.md: bundle run it all -> bundle and run it all; horiztonal -> horizontal; It will also distributes -> It will also distribute
  • install/ubuntu.md: udpates -> updates; optionaly -> optionally; certifiate -> certificate; will not be redirect to HTTPS -> redirected
  • groups.md: explicitely -> explicitly; preferrable -> preferable; great a limiting -> great at limiting
  • rendering.md: supercript -> superscript; Allow HTML: Enable HTML tabs in content -> tags
  • troubleshooting.md: Administrator Area -> Administration Area; functionnality -> functionality
  • install/docker.md: file containing to the database password -> file containing the database password

Two notes on that list:

  • certifiate is inside a quoted log line. I checked server/core/letsencrypt.js in requarks/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 Area appears exactly once in the whole repo; Administration Area appears 17 times, including two lines above it in the same file.

Additionally noticed while reviewing (not in the original report)

  • dev/comments.md: An comments module adds discussion capabitilies -> A comments module adds discussion capabilities
  • install/kubernetes.md: persistance -> persistence; Persistant Volume Claims -> Persistent; Postgers PVC Storage Request -> Postgres (matching the row above it); ## PostgresSQL -> ## PostgreSQL
  • install/transfer.md: mentionned -> mentioned
  • auth/slack.md: Nagivate -> Navigate
  • auth/keycloak.md: You wil need -> You will need
  • install/aws.md: preferrably -> preferably
  • install/sideload.md: the files localed in -> the files located in
  • install/config.md: Refer to to the -> Refer to the
  • guide/assets.md: specic alignment -> specific alignment
  • dev.md: A reproducable build workflow -> A reproducible build workflow

Deliberately left alone

  • There're (9 occurrences repo-wide, including groups.md) — that is a consistent authorial voice, not a one-off slip.
  • javascript -> JavaScript in troubleshooting.md — casing preference, and line 68 is a heading whose anchor would change.
  • The releases/*.md archive (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.
  • YAML front-matter on every page (date, description, …), since that is synced page metadata.
  • favourite in install/awsecs.md (dialect) and ressources in dev/api.md's description.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant