Commit Graph

38 Commits

Author SHA1 Message Date
Adam Altman
e677c17aab docs: fix typo in url (#1744) 2024-10-03 01:46:40 +00:00
Adam Altman
611c3ba173 docs: move to 3-column tables for push and push-status commands (#1681) 2024-08-24 07:12:20 -05:00
Lorna Jane Mitchell
1e9e58fd2e docs: add the realm push commands (#1654)
* docs: add the realm push commands

* Update docs/commands/push-status.md

* minor grammar edits

* updates links on push command page

* docs: reword duplicate headings

* docs: run prettier on updated/added markdown files

* docs: fix incorrect markdoc syntax

* minor wording updates

* docs: tidy the formatting

* docs: tidy formatting on push-status

---------

Co-authored-by: JLekawa <164185257+JLekawa@users.noreply.github.com>
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
Co-authored-by: Adam Altman <adam@redocly.com>
2024-08-23 08:11:17 -05:00
dianacheung
4c3d8cf84f docs: update commands documentation (issue 1429) and minor corrections (#1560)
* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier

* docs: updated commands documentation per issue 1429 and included pr 1560 feedback

* docs: minor formatting and copyedits

---------

Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2024-07-05 20:59:59 +01:00
romana-la
875dfa8d8b docs: replace relative links leading outside of the directory (#1515)
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2024-05-08 11:15:57 +01:00
Ihor Karpiuk
0c52110c80 chore: set default severity for lint config (#1292) 2023-10-19 16:23:18 +03:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Lorna Jane Mitchell
daf030b7a8 Custom plugin documentation (#1222)
* Remove extra 'resources' landing page, redirect from main one

* Move custom plugins file to its own directory, add redirect to handle

* docs: split the custom plugins page into one page per feature

* docs: extend decorators explanation and link to it from the custom plugins section

* docs: Fix all the links that were broken when I moved things

* Apply excellent suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: Add examples of how to use the custom rule

* docs: Replace the nested visitor example with an object rather than a function

* Update custom-rules.md

minor consistency edits

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: clearer explanation of skip, and finish a broken sentence

* Update docs/custom-plugins/index.md

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* Apply suggestions from code review

Co-authored-by: Adam Altman <adam@redoc.ly>

* docs: use object rather than function for visitor

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
Co-authored-by: Adam Altman <adam@redoc.ly>
2023-08-16 14:26:56 +01:00
Lorna Jane Mitchell
9dc78a6d3f docs: Improve CLI usage wording (#1162)
* chore: Tidy up usage options and wording

* docs: Update/refresh command docs pages, add completion page

* chore: run prettier

* fix: keep the previous push command format for backward compatibility

* fix: update test snapshots to match new usage output

* chore: run prettier

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-07-12 10:30:05 +01:00
redocly-bot
e43228e59e sync: Synced local 'docs/' with remote 'docs/cli/' 2023-07-08 14:18:44 +00:00
Andrew Tatomyr
0ce9cab59a docs: documentation for telemetry + contributing guide update (#1139)
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: Ihor Karpiuk <ihor.karpiuk@redocly.com>
2023-06-26 21:26:19 +03:00
redocly-bot
80a412178e sync: Synced local 'docs/' with remote 'docs/cli/' 2023-06-13 17:13:37 +00:00
Lorna Jane Mitchell
909fb471ca Add Vale for prose linting (#1099)
* feat: Add Vale configuration and rules

* docs: Fix top-level files to match Vale rules

* docs: Vale updates for the commands docs

* docs: apply Vale updates to the decorator docs

* docs: Update guides to match Vale rules

* docs: update rules and other content to meet Vale standards

* docs: add Vale link and information to CONTRIBUTING

* feat: Add GitHub action for Vale

* docs: minor editing to readme.md

* docs: minor editing to the changelog.md file

* docs: minor edits to the join.md file in commands folder

* docs: minor edits to lint.md file in the commands directory

* docs: minor edit to the login.md file in the commands directory

* docs: minor edits to the preview.md file in the commands directory

* docs: minor edits to push.md file in the comands directory

* docs: minor edits to the info-description-override.md file in the decorators directory

* docs: minor edits to the configure-rules.md file in the guides directory

* docs: minor edits to custom-plugin.md file in the resources directory

* docs: minor editing to the no-http-verbs-in-paths.md file in the rules directory

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-06-01 10:10:43 +01:00
Andrew Tatomyr
6729869869 docs: make greedy arrays false in yargs (#1084) 2023-05-25 16:28:29 +02:00
Lorna Jane Mitchell
3e461d5cc4 Add MLC for link checking (#1097)
* docs: add mlc config and github action to check links

Ignores relative links since we can only check those from the main
website project.

* docs: update redirecting links and configure some ignore patterns
2023-05-25 15:12:36 +01:00
Adam Altman
a2213bb5db docs: rename features.openapi and features.mockServer in config (#983) 2023-01-25 12:05:03 +02:00
Ivan Osypov
bb8b9121c4 feat: ability to add other files and folders to push (#842)
* feat: ability to add other files and folders to push

* Remove console.log

* Prettier fix

* Merge args in loadConfig

* Update docs/commands/push.md

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

* Update packages/cli/src/commands/push.ts

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

* Make code cleaner

* add test for --files arg

* Support files in apos section

* Change nerge config logic

* get unique files

* fix test

* fix test

* fix test

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2022-09-16 10:27:51 +03:00
Andrew Tatomyr
b325e6f503 chore: rename 'entrypoints' into 'apis' (#802) 2022-08-09 18:07:23 +02:00
redocly-bot
417c28b6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-07-18 22:16:28 +00:00
Anton Kozachuk
f9ab85e1ee fix: run-id parameter is not working properly (#735)
Co-authored-by: Anton Kozachuk <antonkozachuk@Antons-MacBook-Pro.local>
2022-06-22 18:50:23 +03:00
redocly-bot
4d8cf1f186 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-14 18:42:52 +00:00
redocly-bot
5c1a65af9c sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-12 09:15:22 +00:00
redocly-bot
ee47cc3046 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-11 02:04:53 +00:00
Yevhen Smoliy
2bb8d82c7e feat: added --public option for push command (#667)
* feat: added --public option for push command

fix: fixed according to comments, splited docs into separate PR

* docs: added information about `--public` option for push

docs: fixed table after conflicts resolving

* Apply suggestions from code review

* fix: removed `optional` from doc table.

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
2022-05-10 17:37:40 +03:00
Roman Hotsiy
1cacff2044 chore: rename package to @redocly/cli (#672)
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@gmail.com>
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2022-05-06 16:12:56 +02:00
redocly-bot
f4db5622b3 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-04 19:32:45 +00:00
redocly-bot
d7ed5092e8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-04 18:36:13 +00:00
volodymyr-rutskyi
2cddb768e8 Feat: Skip decorator option for push command (#614)
* Add --skip-decorator option to push command

* docs: --skip-decorator option for push command

* feat: support new redocly.yaml config structure in push command

* chore: fix tests after change

* fix: make sure npm run e2e does not run unit tests

* fix: remove unnecessary lint call

* docs: update text and add example of skipping multiple decorators
2022-04-04 11:39:52 +03:00
redocly-bot
297082a16b sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-23 22:07:26 +00:00
redocly-bot
e152cc45ff sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-14 10:21:56 +00:00
redocly-bot
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
Andriy Leliv
5766f71a06 feat: support region for login and other commands (#459)
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2021-12-14 08:50:27 +02:00
redocly-bot
6d29a9bc2c sync: Synced local 'docs/' with remote 'docs/cli/' 2021-11-24 20:12:04 +00:00
Antonio
5e7b82fb14 docs: revised the push command for openapi-cli (#363)
* docs: added use cases for --run-id option, push command

* docs: added several ways of authorization with push command

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
Co-authored-by: Adam Altman <adam@rebilly.com>
2021-11-24 06:58:35 -06:00
redocly-bot
833ad57900 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-13 13:08:16 +00:00
redocly-bot
2143028637 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-05 01:36:10 +00:00
redocly-bot
acc0e31e22 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-07-06 12:49:53 +00:00