Skip to content

Fix typos in configuration.md#45

Open
Ricket wants to merge 1 commit into
Leantime:masterfrom
Ricket:patch-1
Open

Fix typos in configuration.md#45
Ricket wants to merge 1 commit into
Leantime:masterfrom
Ricket:patch-1

Conversation

@Ricket

@Ricket Ricket commented Oct 4, 2025

Copy link
Copy Markdown

I noticed the OpenID-Conenct typo while reading the docs, so I came here to fix that typo and ended up finding several more. The mistakes were found by AI but fixed by hand. Expanding "sitename" to "site name" is perhaps the only controversial one, feel free to undo that one if you prefer.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Thank you!

@marcelfolaron

Copy link
Copy Markdown
Contributor

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

Intent: Batch typo/grammar cleanup across installation/configuration.md (OIDC heading, LDAP section, telemetry section, "Sitename"→"Site name", plus many small spelling fixes).

Change requests (must address before merge):

  1. New typo introduced — blocker. installation/configuration.md:25 changes (can be emtpy)(can be empyy). The target word is empty. Please correct:
    -LEAN_S3_FOLDER_NAME=''          # Foldername within S3 (can be empyy)
    +LEAN_S3_FOLDER_NAME=''          # Foldername within S3 (can be empty)
  2. Overlap with Typo in configuration.md #46. The OpenID-ConenctOpenID-Connect heading fix (configuration.md:~176) is also the entire content of Typo in configuration.md #46. This PR supersedes Typo in configuration.md #46 — recommend merging this one and closing Typo in configuration.md #46 to avoid a conflict.
  3. Optional / judgment call: the SitenameSite name expansion (configuration.md:166 heading and body) is a wording change, not a typo. The author flagged it as debatable; fine to keep, but confirm it doesn't break any in-page anchor links that reference #sitename.

Acceptance checklist (must pass before merge):

  1. CLA signed / green.
  2. The empyyempty fix (item 1) is applied — do not merge with the introduced typo.
  3. Typo in configuration.md #46 closed as superseded (dedupe), and any #sitename anchor references updated if the heading text changed.

CI status: No unit-test gate for docs. Primary gates are CLA + the manual correctness check above. The introduced empyy typo is the one hard blocker here.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review — status: needs-info (advisory) · priority: P3 · next action: author fixes one introduced typo · owner: @Ricket

1. Intent: Fixes a batch of spelling/capitalization typos across installation/configuration.md (environment, process, across, method, separated, necessary, "OpenID-Conenct" → "OpenID-Connect", consistent "Leantime" casing, "Sitename" → "Site name").

2. Change requests:

  • Blocker (introduced typo): the S3 folder-name line replaces one typo with another. At installation/configuration.md:25:
    -LEAN_S3_FOLDER_NAME=''          # Foldername within S3 (can be emtpy)
    +LEAN_S3_FOLDER_NAME=''          # Foldername within S3 (can be empyy)
    emtpyempyy is still wrong; it should be empty. Please correct this before merge.
  • Optional (scope): the "Sitename" → "Site name" heading change at configuration.md:166 alters an anchor (#sitename#site-name). Low risk since the docs don't appear to deep-link it, but worth a grep for #sitename before merging.
  • Overlap: this PR fully supersedes Typo in configuration.md #46 (same OIDC typo, single line). If you merge Fix typos in configuration.md #45, close Typo in configuration.md #46 as included.

3. Acceptance checklist (must pass before merge):

  • empyyempty corrected (see above)
  • Docs build/link-check CI green
  • Confirm no external links rely on the old #sitename anchor

4. CI status: Check-run status isn't readable through my current tooling — please confirm green in the UI. Docs-only, no behavior change, so no test is required; the one blocker above is a content correctness issue, not a test gap.

Advisory review 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.

2 participants