diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13a6bb39a..847e3e220 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,14 +58,24 @@ Once your changes are ready to submit for review: ### Code generation -The entire content of the API folder is generated as well as the `docs/reference.asciidoc` file.
-If you want to run the code generation you should run the following command: +The contents of the API folder and the `docs/reference.asciidoc` file are generated by a script.
+To run the script, use the following command: + ```sh -node scripts/generate --tag -# or -node scripts/generate --branch +node scripts/generate --version +``` + +For example: + +```sh +node scripts/generate --version 7.15.0 +``` + +To run the script for an unreleased snapshot version, append `-SNAPSHOT` to the version name. For example: + +```sh +node scripts/generate --version 8.0.0-SNAPSHOT ``` -Then you should copy the content of `api/generated.d.ts` into the `index.d.ts` file *(automate this step would be a nice pr!)*. ### Testing There are different test scripts, usually during development you only need to run `npm test`, but if you want you can run just a part of the suite, following you will find all the testing scripts and what they do. diff --git a/scripts/utils/generateDocs.js b/scripts/utils/generateDocs.js index 9f681ab49..8d114eefa 100644 --- a/scripts/utils/generateDocs.js +++ b/scripts/utils/generateDocs.js @@ -222,7 +222,7 @@ function generateApiDoc (spec) { doc += `link:${documentationUrl}[Documentation] +\n` } if (codeExamples.includes(name)) { - doc += `{jsclient}/${name.replace(/\./g, '_')}_examples.html[Code Example] +\n` + doc += `<<${name.replace(/\./g, '_')}_examples,Code Example>> +\n` } if (params.length !== 0) {