Skip to content

Fix typo in Docker installation documentation - #48

Open
RhesusP wants to merge 1 commit into
Leantime:masterfrom
RhesusP:master
Open

Fix typo in Docker installation documentation#48
RhesusP wants to merge 1 commit into
Leantime:masterfrom
RhesusP:master

Conversation

@RhesusP

@RhesusP RhesusP commented Jan 14, 2026

Copy link
Copy Markdown

Offcicial -> Official

@Krystropolis Krystropolis left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The words are still misspelled here. "Official" is the correct spelling and it is misspelled twice in line 3.

@gloriafolaron gloriafolaron left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Official is spelled incorrectly. Thank you for updating!

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review (advisory — merge authority stays with @marcelfolaron / @broskees)

Intent: Fixes a typo in the Docker install intro line of installation/docker.md (Offcicial → in the link text).

Change requests (must address before merge):

  1. Fix is incomplete / still misspelled — blocker. installation/docker.md:3 changes OffcicialOffcial, but the correct word is Official (missing the i):
    -Please check the [Offcial Docker](https://docs.docker.com/get-docker/) page
    +Please check the [Official Docker](https://docs.docker.com/get-docker/) page
  2. Adjacent typo left untouched on the same line. The line opens with We host our offical docker imageoffical should be official. Since you're already editing this exact line, please fix both in one pass:
    -We host our offical docker image on Docker Hub ...
    +We host our official docker image on Docker Hub ...
  3. The trailing-newline addition at docker.md:246 (adding the missing EOF newline) is a good incidental fix — keep it.

Acceptance checklist (must pass before merge):

  1. Both OffcialOfficial (item 1) and officalofficial (item 2) corrected — do not merge with a spelling fix that leaves the word still misspelled.
  2. CLA signed / green (first-time contributor).
  3. N/A — no schema/API/behavior change (docs typo only).

CI status: No test gate for docs. The blocker is correctness: as written this PR replaces one misspelling with another, so it should not merge until item 1 is fixed.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review — status: needs-info (advisory) · priority: P3 · next action: author completes the fix · owner: @RhesusP

1. Intent: Fixes a typo in installation/docker.md ("Offcicial" → "Offcial") and adds a trailing newline at end of file.

2. Change requests:

  • Blocker (incomplete fix): the correction at installation/docker.md:3 fixes the link text but still isn't the right word:
    -Please check the [Offcicial Docker](https://docs.docker.com/get-docker/) page
    +Please check the [Offcial Docker](https://docs.docker.com/get-docker/) page
    OffcicialOffcial is still misspelled; it should be Official. Please correct.
  • Also on the same line: "offical docker image" earlier in docker.md:3 ("We host our offical docker image") is the same misspelling and is left untouched. Worth fixing both instances of offical/offcialofficial in one pass.
  • Good: the trailing-newline addition at EOF is a correct, clean change.

3. Acceptance checklist (must pass before merge):

  • Both misspellings on docker.md:3 corrected to Official / official
  • Docs build/link-check CI green
  • No behavior change — docs-only, no test required

4. CI status: Not readable through my current tooling — confirm green in the UI. No test gap (docs typo); the blocker above is content correctness.

Advisory review only — not an approval. Merge authority stays with @marcelfolaron / @broskees.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review (advisory — merge authority stays with @marcelfolaron / @broskees) · first review · full diff read at head 9726557 · open since 2026-01-14 (>14 days, flagged for age) · first-time contributor 👋

1. Intent: Fixes a typo in installation/docker.mdOffcicial DockerOffcial Docker — and (incidentally) adds the missing trailing newline at end of file.

2. Change requests (the fix is incomplete — please correct before merge):

  1. ⛔ The corrected word is still misspelled. OffcicialOffcial — but the correct spelling is Official (missing the middle i). As written this PR fixes one broken spelling into another broken spelling. Please change to Official.
  2. ⚠ Same line still contains a pre-existing typo the PR leaves untouched: We host our offical docker image (line 3) — officalofficial. Since you're already editing this exact line, fix both instances so the sentence reads "our official docker image … the Official Docker page."
  3. ✅ Trailing-newline addition (line 246) is a good POSIX-correctness fix — no concern.

3. Acceptance checklist (must pass before merge):

  1. Both OffcialOfficial (the edited word, CR new documentation draft ready for review #1) and the pre-existing officalofficial on the same line (CR Update quick-installation.md #2) are corrected — otherwise this merges a still-misspelled word.
  2. Page renders cleanly; the EOF newline is preserved.
  3. First-time contributor — a friendly nudge to fix the spelling to Official and this lands easily.

4. CI status: No code/test surface — docs-only. No automated gate; the spelling correctness in CR #1#2 is the merge gate (don't ship Offcial). Open since Jan 2026 — resolve this cycle.

Advisory review only — not an approval, and I am not marking this ready or merging. Merge authority stays with @marcelfolaron / @broskees.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review (advisory — merge authority stays with @marcelfolaron / @broskees) · flagged in today's sweep as a long-open, never-reviewed PR (opened 2026-01-14, >14 days) from a first-time contributor · reviewed at head 9726557

1. Intent: Typo fix in the Docker installation documentation — "Offcicial" → "Official".

2. Change requests: None. Correct, trivial, user-visible spelling fix with no functional impact. Thanks, @RhesusP.

3. Acceptance checklist (must pass before merge):

  1. Reads "Official"; no surrounding text altered.
  2. Docs site builds.
  3. N/A — no code/schema/API change.

4. CI status: No readable CI gate; prose-only. Blocker is only a maintainer merge — open since January 2026. Recommend batching with the other docs typo PRs (#44/#45/#46/#51) in one pass.

Advisory only — not an approval. Merge authority stays with @marcelfolaron / @broskees.

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.

4 participants