Repository navigation
feat: docs - #179
Merged
Merged
feat: docs#179
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The CLI documentation still shows membership commands missing project and advertises nonexistent task commands, with the task synopsis also needing correction in nine localized copies.
2 open issues
What changed in this PR
Adds documentation for managing Semaphore servers through semaphore client, extending the existing CLI reference with terminal and scripting workflows.
Changes:
- Adds a client guide covering authentication, configuration, output, exit codes, and CI examples in English and nine translations.
- Expands the generated command reference with client commands, flags, and examples.
- Links the guide from the sidebar and CLI overview pages.
| File | Description |
|---|---|
sidebars.js |
Adds the client guide to CLI navigation. |
i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Chinese client guide. |
i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Chinese client guide. |
i18n/sr/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Serbian client guide. |
i18n/sr/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Serbian client guide. |
i18n/ru/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Russian client guide. |
i18n/ru/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Russian client guide. |
i18n/pt/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Portuguese client guide. |
i18n/pt/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Portuguese client guide. |
i18n/ko/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Korean client guide. |
i18n/ko/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Korean client guide. |
i18n/ja/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Japanese client guide. |
i18n/ja/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Japanese client guide. |
i18n/it/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Italian client guide. |
i18n/it/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Italian client guide. |
i18n/fr/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the French client guide. |
i18n/fr/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the French client guide. |
i18n/es/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the Spanish client guide. |
i18n/es/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the Spanish client guide. |
i18n/de/docusaurus-plugin-content-docs/current/reference/cli/README.md |
Links the German client guide. |
i18n/de/docusaurus-plugin-content-docs/current/reference/cli/client.md |
Adds the German client guide. |
docs/reference/cli/README.md |
Links the English client guide. |
docs/reference/cli/commands.md |
Adds client command reference entries and adjusts placeholder escaping. |
docs/reference/cli/client.md |
Adds the English client guide and scripting examples. |
Review effort: Balanced
Comment on lines
+19
to
+21
| (`template list` and `templates list` are the same). Every resource has `list`, | ||
| `get`, `create`, `update` and `delete`; tasks add `run`, `logs`, `wait`, `stop` | ||
| and the like. The exhaustive, generated list of every command and flag is in the |
Comment on lines
+840
to
+842
| semaphore client member list -p 1 | ||
| semaphore client member get "bob" -p 1 -o json | ||
| semaphore client member delete "bob" -p 1 -y |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.