diff --git a/contributing-guides/maintainers-guide.md b/contributing-guides/maintainers-guide.md index a53f4e84d1..fc3a3ced0d 100644 --- a/contributing-guides/maintainers-guide.md +++ b/contributing-guides/maintainers-guide.md @@ -68,8 +68,8 @@ for the behavior expected of tldr-pages maintainers. - If it only has one approval, please read the next point. - If a PR fails to get a review from a second maintainer after a few days, - the first maintainer should ping others for review. - - If it still lingers around for **over a week without a second maintainer’s approval**, the first maintainer (if Owner) can go ahead and merge it. + the first maintainer should ping others for review. + - If it still lingers around for **over a week without a second maintainer’s approval**, the first maintainer (if Owner) can go ahead and merge it. Otherwise, a message can be sent in the chatroom asking other maintainers to review the PR. - If the only issues holding up a merge are **trivial fixes** @@ -163,14 +163,14 @@ For reference to see if a contributor has signed the CLA, visit the dashboard at 1. Merge all applicable PRs that modify the client specification and ensure they are documented in the [CHANGELOG section of client specification](/CLIENT-SPECIFICATION.md#changelog). 2. Bump the version to the upcoming release (in the client specification file) and inform other maintainers in the chatroom about the release. -3. Clone the repository locally to your device: +3. Clone the repository locally to your device: ```sh git clone https://github.com/tldr-pages/tldr ``` 4. Cross check the additions, version and changelog details in the client specification file. -5. Create a signed tag using the command +5. Create a signed tag using the command ```sh git tag -s vX.Y.Z @@ -183,13 +183,13 @@ git tag -s vX.Y.Z > If any commits are merged after the client specification file's version bump commit and before tagging, when creating the tag > you can use the command: `git tag -s vX.Y.Z ` (i.e. `git tag -s v2.3 3b17800`) to tag a older commit. -6. Verify the created signed tag's details using the command: +6. Verify the created signed tag's details using the command: ```sh git tag -v vX.Y.Z ``` -7. Now, push the tag to the repository using the command: +7. Now, push the tag to the repository using the command: ```sh git push origin vX.Y.Z diff --git a/contributing-guides/style-guide.ko.md b/contributing-guides/style-guide.ko.md index 8b0dc2dc27..89b896f6d7 100644 --- a/contributing-guides/style-guide.ko.md +++ b/contributing-guides/style-guide.ko.md @@ -105,7 +105,7 @@ tldr --render path/to/tldr_page.md ### Naming - 짧지만 설명적인 토큰을 사용하세요. -- 파일 및 디렉토리 경로에 대한 참조의 경우: +- 파일 및 디렉토리 경로에 대한 참조의 경우: `{{path/to/}}`의 포맷을 사용하세요. (암시적인 경로인 경우는 제외!) - 경로가 상대경로일 수 없지만 파일 시스템의 root에서 시작해야 하는 경우 diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index a270e637ab..cf6b026297 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -228,7 +228,7 @@ In the following case `just.md` is the filename of the disambiguation page while ### Grouping commands -Sometimes commands are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. +Sometimes commands are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. For example `adb disconnect` has a single way using it, but `adb` is expansive enough that it doesn't fit in the main page. Normally, `adb disconnect` is used in combination with `adb pair` and `adb connect`, thus it makes sense to group these together into a single page. For example: diff --git a/contributing-guides/translation-templates/common-arguments.md b/contributing-guides/translation-templates/common-arguments.md index f46528a0bd..c0f59f755c 100644 --- a/contributing-guides/translation-templates/common-arguments.md +++ b/contributing-guides/translation-templates/common-arguments.md @@ -1,8 +1,8 @@ # Common arguments -This page provides translations of commonly used arguments to simplify maintaining pages in foreign languages. -The best way to edit this file is by using [tableconvert.com](https://tableconvert.com/). -There, the old table can be **imported**, **edited** in a WYSIWYG editor and **exported** again. +This page provides translations of commonly used arguments to simplify maintaining pages in foreign languages.\ +The best way to edit this file is by using [tableconvert.com](https://tableconvert.com/).\ +There, the old table can be **imported**, **edited** in a WYSIWYG editor and **exported** again.\ Only the left-alignment of the header gets lost and has to be re-added again (`|----` → `|:---`). > [!NOTE] diff --git a/contributing-guides/translation-templates/more-info-link.md b/contributing-guides/translation-templates/more-info-link.md index 8a054ea5fb..791caa5309 100644 --- a/contributing-guides/translation-templates/more-info-link.md +++ b/contributing-guides/translation-templates/more-info-link.md @@ -1,6 +1,6 @@ # More information link -For all our pages we suggest having a [more information link](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#more-information-links) which contains a link +For all our pages we suggest having a [more information link](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#more-information-links) which contains a link to the official documentation of the command-line reference or the man page. This file contains a list of all translations of the more information link template from [set-more-info-link.py](https://github.com/tldr-pages/tldr/blob/main/scripts/set-more-info-link.py#L66-L102).