Tracker issue: 2023

[kbdharun]

Documenting Progress

This checklist was moved from #10755 (as suggested by @sebastiaanspeck).

Section 1: Main repo and Org

---

To update

Note

To avoid merge conflicts, if there is an open PR updating the style guide, it is recommended to wait for it to get merged before creating a new one.

• Style guide

  • Add clear information about more information links (and what URLs should be used for translation pages) →style-guide: add and update documentation about URLs #11320
  • Add information to not localize Microsoft Learn URLs [Existing informal rule] → style-guide: add and update documentation about URLs #11320
  • Document Display help and Display version generic term preference and order. [Existing informal rule] → style-guide: add help and version commands section #11854
  • Document usage of mnemonics → style-guide: add short option mnemonics, and windows- and powershell-specific rules #11619
  • Document Windows and PowerShell specific rules → style-guide: add short option mnemonics, and windows- and powershell-specific rules #11619
  • Document how multiple examples can be concatenated and separated with | [Existing informal rule] (Already present, the wording was improved)
  • Document Capitalizing Brand names/Project names in applicable places and enclosing package names inside backticks. [Existing informal rule] (Partially done) → cleanup: update style guide #11860
  • Document enclosing links inside angular brackets. [Existing informal rule] → style-guide: add and update documentation about URLs #11320
  • Document how to handle passing arguments → style-guide: add guidelines for --opt arg, improve wording #10906
  • Document we prefer long options, see Encourage using long parameter options and mnemonic tags in our style guide #8304 (with exceptions for some pages) [Existing informal rule] → style-guide: add short option mnemonics, and windows- and powershell-specific rules #11619
  • Document not specifying the platform/CLI in the page descriptions. Only encourage it for GUI applications. [Existing informal rule] → krita: move to common, update description; style-guide: add description guidelines #10858
  • Document preferring stdout over standard output [Existing informal rule] → style-guide: add guidelines for standard streams; fix remaining pages #11196
  • Document highlighting file names [Existing informal rule] → krita: move to common, update description; style-guide: add description guidelines #10858
  • Document wrapping file extensions in Quotes Backticks (Ref. zforce: add page #10868) → krita: move to common, update description; style-guide: add description guidelines #10858
  • Document preference for non-versioned links. (i.e latest or none) →style-guide: add and update documentation about URLs #11320
  • Document requirement for spacing on French pages [Existing informal rule] → cleanup: update style guide #11860
  • Document requirement to not translate acronyms → cleanup: update style guide #11860
  • Document page heading to be kept as the command name [Existing informal rule] (except when it starts with a symbol) → cleanup: update style guide #11860
  • Document how to highlight keycaps → cleanup: update style guide #11860

• Contributing guide

  • Document suggestion to enable check for allowing MAINTAINERS to edit PRs [Existing informal rule] → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Document how to seamlessly add a new language to tldr and which files to prefill for translation templates → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Document that translations must be done based on the English page → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Document how to test pages locally using tldr-lint before creating a PR → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Document how to batch suggestions and make a single commit → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Add more commit examples → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Document how to run the test script to reformat code for Black style, etc → CONTRIBUTING: update page, fix Markdown syntax #11669
  • Document how to handle name collisions with files → cleanup: update contributing guide #11861
  • Add suggestion that when typo fixes are done by native speakers (they must update the page if it's outdated too) → cleanup: update contributing guide #11861
  • Document that you can use the main page of a tool/utility to reference subcommands tldr pages → cleanup: update contributing guide #11861

• Scripts directory

  • Document what each script does → feat: add documentation for scripts; update wrong filename script #11810

• PR template

  • Add comment highlighting running tldr-lint locally or explaining the PR would go through tldr-bot running the same → PULL_REQUEST_TEMPLATE: add testing page using tldr-lint to checklist #11671 (Proposal dropped)

• Client Specification

  • Document to escape the placeholder syntax → CLIENT-SPECIFICATION: fix typo, add a way to escape the placeholder syntax #10730
  • Add suggestion that clients should detect platforms in the pages directory automatically → CLIENT-SPECIFICATION: add automatic platform detection suggestion, fix Markdown syntax #11523

• MAINTAINERS guide

  • Add a section about transparency and minimum time before taking over the PR → MAINTAINERS-GUIDE: update page, add new Transparency section #10818
  • Document preference to include the coauthored part in the commit message for non-trivial PRs → cleanup: update maintainers guide #11862
  • Document preference to use "decision" label for PRs that need discussion (and shouldn't be merged) → cleanup: update maintainers guide #11862
  • Remove minimum time to wait before merging PR requirement → MAINTAINERS-GUIDE: remove minimum merge wait time requirement #11391
  • Add suggested time requirement for new additions → cleanup: update maintainers guide #11862
  • Add documentation on handling failing actions/workflows and waiting for CLA checks →cleanup: update maintainers guide #11862
  • Add "platform addition consideration section" to document notability criteria (i.e should have a stable release, etc) for adding a new platform → Dropped this as we rarely add new platforms and the addition must be discussed with the maintainers in the chatroom then and there (and a general guideline would be too restrictive).

• Community roles

  • Document the CODEOWNERS file and procedure to add yourself (maintainers) to it → COMMUNITY-ROLES: document CODEOWNERS file #11646

---

To create

• Issue template
  • Page modification template → ISSUE-TEMPLATES: add page modification request template; update page request template #10826
  • Let's Document template → ISSUE-TEMPLATES: add Let's document; update others #11326

---

Others

Platform Additions

• Add support for OpenBSD platform → openbsd: add directory; openbsd/pkg_{add,info,delete}: add page #10698
• Add OpenBSD support to the Web client → feat: add OpenBSD platform and update dependencies InBrowserApp/tldr.inbrowser.app#18
• Add support for FreeBSD and NetBSD platforms→ freebsd, netbsd: add directory; pkg, pkgin: add page #11313
• Add FreeBSD support to the Web client → feat: add FreeBSD and NetBSD platforms InBrowserApp/tldr.inbrowser.app#19

---

Miscellaneous

• Standardize scripts to follow a uniform convention (Ref. scripts/deploy.sh: exit immediately if there aren't any changes #11836 (comment)) →
• Build and deploy tldr book PDF for translations → scripts: build and deploy PDF pages for translations #10846
• Deprecation of language team in favor of CODEOWNERS file → [Archive] Deprecated language teams in Org in favor of the CODEOWNERS file #11188
• Standardize Repo and Security settings throughout the Org → [Archive] Repositories settings changes and standardization throughout the Organization #11187
• Remove unused webhooks and applications → [Archive] Removed Inactive and unreachable webhooks from the tldr repo #11153, [Archive] Removed Probot Stale, Codacy Production and Travis CI GitHub apps; Codacy webhook from extldr #11157
• Set main as the default branch for all Repos
• Add branch protection rule for all repos (except tlrc and tldr-translation-pairs-gen) → [Archive] Default branch in extldr has been switched to main, branch protection has been enabled for main branch #10830, [Archive] Branch protection for main branch has been enabled for tldr-lint #10831, [Archive] Updated default branch from master -> main in tldr-node-client, added branch protection rule for the main branch #10832, [Archive] Branch protection for main branch has been enabled for tldr-c-client #10833
• Add support for generating PDFs for specific platforms → feat/scripts: support generating PDFs for platforms #11195
• Run scripts and add standard (alias page) and more information link translation → pages/*: add standard translation and links #11331
• Revert standard translation script commit → Revert "pages/*: add standard translation and links (#11331)" #11374

---

Section 2: tlrc

• Addition of new official client written in Rust (tlrc)
• Add tlrc to Winget → Add package: tldr-pages.tlrc 1.6.0 microsoft/winget-pkgs#123733
• Add tlrc to Homebrew → tlrc 1.7.1 (new formula) Homebrew/homebrew-core#152996
• Replace C client with tlrc in Wiki
• Replace C client with tlrc in README →README: update Homebrew client to Rust client tlrc #11369

[sebastiaanspeck]

For the French style-guide; only I have found it is common case to add an extra space for the next characters, not only the colon:

• Question mark
• Exclamation mark
• Colon
• Semi-colon
• Quotation mark
• Percentage symbol
• Currency symbol

[kbdharun]

Yep, that seems to be the case. While creating a PR we can mention it too.

[gutjuri]

Regarding the contributing guide: we could mention that one can run the linter locally.

Imo this would then close #4986.

[kbdharun]

Regarding the contributing guide: we could mention that one can run the linter locally.

Imo this would then close #4986.

Agreed, I have some free time tomorrow, will work on this.