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.

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: add cli config reference #1483

Merged
merged 13 commits into from
Mar 26, 2024
Merged

docs: add cli config reference #1483

merged 13 commits into from
Mar 26, 2024

Conversation

lornajane
Copy link
Collaborator

What/Why/How?

We have some config options that are in use in the CLI, but the rest of the config docs are still private for the new products. Create matching-format pages for the options that belong here so we can link to them.

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

Copy link

changeset-bot bot commented Mar 14, 2024

⚠️ No Changeset found

Latest commit: 3448a6c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Mar 14, 2024

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.004 ± 0.017 0.978 1.041 1.01 ± 0.03
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 0.996 ± 0.023 0.967 1.047 1.00

Copy link
Contributor

github-actions bot commented Mar 14, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.65% 4395/5734
🟡 Branches 66.72% 2360/3537
🟡 Functions 70.1% 722/1030
🟡 Lines 76.82% 4126/5371

Test suite run success

716 tests passing in 101 suites.

Report generated by 🧪jest coverage report action from 3448a6c

@tatomyr tatomyr changed the title add cli config reference docs: add cli config reference Mar 14, 2024
@lornajane lornajane requested a review from a team March 20, 2024 17:39
@lornajane lornajane marked this pull request as ready for review March 20, 2024 17:40
@lornajane lornajane requested a review from a team as a code owner March 20, 2024 17:40
docs/configuration/reference/extends.md Outdated Show resolved Hide resolved
docs/configuration/reference/apis.md Show resolved Hide resolved
docs/configuration/reference/apis.md Outdated Show resolved Hide resolved
docs/configuration/reference/decorators.md Show resolved Hide resolved
docs/configuration/index.md Show resolved Hide resolved

- severity
- string
- Severity level of any problems reported with this decorator. Setting this option is usually only useful for troubleshooting purposes. The value must be one of `error`, `warn`, or `off`, where `off` disables the decorator.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a default?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure, I didn't know this existed until I tried to write the doc and found it!

@lornajane lornajane requested a review from HCloward March 25, 2024 16:59
@lornajane lornajane requested a review from HCloward March 25, 2024 17:14
Copy link
Contributor

@HCloward HCloward left a comment

Choose a reason for hiding this comment

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

Everything looks good to me. I checked all links in sample preview and all work as expected.

lornajane and others added 2 commits March 26, 2024 09:20
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
@lornajane lornajane merged commit 17b73c1 into main Mar 26, 2024
31 checks passed
@lornajane lornajane deleted the add-cli-config-reference branch March 26, 2024 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants