Skip to content

Commit

Permalink
docs: move to 3-column tables for push and push-status commands (#1681)
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamaltman
adamaltman authored Aug 24, 2024
1 parent 1e9e58f commit 611c3ba
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 138 deletions.
16 changes: 8 additions & 8 deletions docs/commands/push-status.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ REDOCLY_AUTHORIZATION=<api-key> redocly push-status <pushId> --organization <org

## Options

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

## Examples

Expand Down
Loading

1 comment on commit 611c3ba

@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 77.5% 4739/6115
🟡 Branches 65.84% 1968/2989
🟡 Functions 71.78% 781/1088
🟡 Lines 77.69% 4471/5755

Test suite run success

765 tests passing in 108 suites.

Report generated by 🧪jest coverage report action from 611c3ba

Please sign in to comment.