Skip to content

Commit

Permalink
docs(all): adds info for finding org and project slugs to push-status…
Browse files Browse the repository at this point in the history
… command doc and removes broken links (#1868)

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

* docs(all): fixes prettier issues
  • Loading branch information
HCloward authored Jan 30, 2025
1 parent 2851c2d commit 4681d7c
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions docs/commands/push-status.md
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

1 comment on commit 4681d7c

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.63% 5052/6425
🟡 Branches 67.23% 2058/3061
🟡 Functions 73.16% 834/1140
🟡 Lines 78.92% 4766/6039

Test suite run success

835 tests passing in 120 suites.

Report generated by 🧪jest coverage report action from 4681d7c

Please sign in to comment.