Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(all): adds info for finding org and project slugs to push-status command doc and removes broken links #1868

Merged
merged 3 commits into from
Jan 30, 2025
Merged

docs(all): adds info for finding org and project slugs to push-status command doc and removes broken links #1868

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81686c0
docs(all): adds info for finding org and project slugs to push-status…
HCloward Jan 28, 2025
47f6d40
docs(all): fixes prettier issues
HCloward Jan 28, 2025
4887aee
Merge branch 'main' into docs/13071-fix-broken-links
HCloward Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions docs/commands/push-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,23 @@ REDOCLY_AUTHORIZATION=<api-key> redocly push-status <pushId> --organization <org

## Options

| Option | Type | Description |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| pushId | string | **REQUIRED.** Identifier of the push you are tracking. Returned as result of the [`push`](./push.md) command. |
| --organization, -o | string | **REQUIRED.** [Organization slug](https://redocly.com/docs/realm/setup/how-to/git-providers/gitlab-self-managed#find-org-slug). |
| --project, -p | string | **REQUIRED.** [Project slug](https://redocly.com/docs/realm/setup/how-to/git-providers/gitlab-self-managed#find-org-slug). |
| --domain, -d | string | The domain that the `push` command pushed to. Default value is [https://app.cloud.redocly.com](https://app.cloud.redocly.com). |
| --wait | boolean | Waits until the build is completed if it is in progress. Default value is `false`. |
| --max-execution-time | number | Maximum wait time for build completion in seconds (used in conjunction with the `--wait` option). Default value is `600`. |
| Option | Type | Description |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| pushId | string | **REQUIRED.** Identifier of the push you are tracking. Returned as result of the [`push`](./push.md) command. |
| --organization, -o | string | **REQUIRED.** [Organization slug](#find-org-slug). |
| --project, -p | string | **REQUIRED.** [Project slug](#find-org-slug). |
| --domain, -d | string | The domain that the `push` command pushed to. Default value is [https://app.cloud.redocly.com](https://app.cloud.redocly.com). |
| --wait | boolean | Waits until the build is completed if it is in progress. Default value is `false`. |
| --max-execution-time | number | Maximum wait time for build completion in seconds (used in conjunction with the `--wait` option). Default value is `600`. |

<details>
<summary>How to find and copy the Reunite organization or project slugs<a id="find-org-slug"></a></summary>

1. Log in to Reunite.
2. Select your organization and project.
3. Copy the value of the `{ORGANIZATION_SLUG}` or `{PROJECT_SLUG}` from the page URL in your browser, based on the following structure, `https://{REDOCLY_HOST}/org/{ORGANIZATION_SLUG}/project/{PROJECT_SLUG}`.

</details>

## Examples

Expand Down
Loading