From f7c00d0395551d66ee477340697b4bbb1527c90f Mon Sep 17 00:00:00 2001 From: p-zielinski <82354717+p-zielinski@users.noreply.github.com> Date: Tue, 17 Oct 2023 16:25:07 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3c1e7d0c..f2ddafbfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,24 +106,19 @@ Good practices: - Copy `.env.example` to `.env` and add to this file your personal API Key created in readme.io: `dashboard` > `configuration` > `API Keys` ### Development process -- For each change / pull request, create your copy of the current documentation, where you will test changes. - - `npm run manage-project -- --vt={your name}-{pull request number}` - Make changes in the repository following patterns and good practices. -- Deploy changes to test your documentation: - - Deploy OpenAPI file by command `rdme openapi ./reference/OpenAPI.json --version=2018-08-01-{your name}-{pull request number} --create`. - - Update tables in mark down tables: - - `npm run build-md-tables-from-openapi` - - `npm run update-md-tables-in-doc` - - Deploy guides and reference pages: `rdme docs ./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}` -- test changes using preview on readme.io -- if changes are fine, then: +- Run `npm run manage-project -- --vt={your name}-{pull request number or tag number} --create` - this will create new version project with your tag number. +- Visit url provided at the end of the script run to test changes using preview on readme.io +- If you need to make a change: + - Do changes... + - Run `npm run manage-project -- --vt={your name}-{pull request number or tag number} --update`- this will update your version. + - Test changes using preview on readme.io +- If changes are fine, then: - Add a note in the changelog. - `git commit` - `git push` - publish PR - ## How to merge PR and update public documentation - Test changes on readme (you can use the version prepared by the contributor).