Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcin Slezak committed Sep 28, 2023
1 parent 545923a commit 985ad0a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@ Good practices:
- Update tables in markdown tables:
- `npm run build-md-tables-from-openapi`
- `npm run update-md-tables-in-doc`
- Deploy OpenAPI file by command `rdme openapi ./reference/OpenAPI.json --id=<<VERSION_ID>>`, where `<<VERSION_ID>>` should be replaced by the OpenAPI ID that can be found on the `API Reference` page (looks screenshot)
- If before created, remove from API Reference the existing OpenAPI file and all specification files.
- Deploy OpenAPI file by command `rdme openapi ./reference/OpenAPI.json --version=2018-08-01-{your name}-{pull request number}`, choose `Create a new spec` option. Command most likely will fail with the message: `We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks`, but so far, we see that this operation still works correctly.
- Deploy guides pages: `rdme docs ./docs/guides --version=2018-08-01-{your name}-{pull request number}`
- Deploy api reference pages: `rdme docs ./docs/reference-docs --version=2018-08-01-{your name}-{pull request number}`
- Fix docs order: `npm run readme-fix-docs-order -- --version=v2018-08-01-{your name}-{pull request number}`
Expand All @@ -131,7 +132,10 @@ Good practices:
- publish PR



## How to merge PR and update public documentation

> [!TODO]
- Test changes on readme (you can use the version prepared by the contributor).
- Ensure the changelog was updated.
- Merge PR to `master` branch
- In reamde.io, change the current documentation version from `v2018-08-01` to `v2018-08-01-deprecated-mm-dd-yyyy`
- Change the name of your new release version from `2018-08-01-{your name}-{pull request number}` to `v2018-08-01`
14 changes: 14 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## 20230928 - Order references/guides script

- Removed `beta` label from qualification API endpoints.
- Described contribution process.
- Added the script to clean up OpenAPI from Stoplight tags.
- Reorganised maintenance scripts.
- Automated the process of updating the data model documents based on the OpenAPI file.
- Improve script which generates markdown tables based on the OpenAPI file.
- Render objects referred directly by $ref.
- fix rendering oneOf + ref.
- Render ref to simple types (e.g. enum)
- Do not duplicate rendering tables when there is more than one reference.
- add the missing title to `23_obj_qualification_object_stacking_rules object.

## 20230925 - Order references/guides script

Added script, located in `docs/script/` directory to quickly update order of references and guides based on `.md` files. For more information please check [Update-Order-Standard-Work.md](automation%2FUpdate-Order-Standard-Work.md) under `Update Order of Docs - AUTOMATIC` section.
Expand Down

0 comments on commit 985ad0a

Please sign in to comment.