Merge branch 'main' into fix/APIC-345/specs-types

Author: shortcuts

README.md

@@ -14,13 +14,13 @@ nvm use && yarn
 yarn docker:setup
 ```
 
-[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/setupRepository)
+[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/setup-repository)
 
 ## Contributing
 
 You can make changes locally and run commands through the docker container.
 
-[Specs CLI commands](https://api-clients-automation.netlify.app/docs/automation/CLI/specsCommands) • [Clients CLI commands](https://api-clients-automation.netlify.app/docs/automation/CLI/clientsCommands) • [CTS CLI commands](https://api-clients-automation.netlify.app/docs/automation/CLI/ctsCommands)
+[Specs CLI commands](https://api-clients-automation.netlify.app/docs/automation/CLI/specs-commands) • [Clients CLI commands](https://api-clients-automation.netlify.app/docs/automation/CLI/clients-commands) • [CTS CLI commands](https://api-clients-automation.netlify.app/docs/automation/CLI/cts-commands)
 
 ### Build and validate specs
 
@@ -30,7 +30,7 @@ You can make changes locally and run commands through the docker container.
 yarn docker build specs <client | all>
 ```
 
-[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/addNewApiClient)
+[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/add-new-api-client)
 
 ### Generate clients based on the [`specs`](./specs/)
 
@@ -40,11 +40,11 @@ yarn docker build specs <client | all>
 yarn docker generate <language | all> <client | all>
 ```
 
-[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/addNewLanguage)
+[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/add-new-language)
 
 ## Testing clients
 
 You can test our generated clients by running:
 
 - The playground [`playground`](./playground) ([Playground](https://api-clients-automation.netlify.app/docs/automation/testing/playground.md))
-- Tests with our [`Common Test Suite`](./tests/) ([Common Test Suite](https://api-clients-automation.netlify.app/docs/automation/testing/commonTestSuite.md)).
+- Tests with our [`Common Test Suite`](./tests/) ([Common Test Suite](https://api-clients-automation.netlify.app/docs/automation/testing/common-test-suite.md)).

netlify.toml

@@ -1,7 +1,7 @@
 [build]
   command="yarn website:build"
   publish="website/build"
-  ignore="git diff --quiet origin/main -- website/"
+  ignore="git diff --quiet $COMMIT_REF $CACHED_COMMIT_REF -- website/"
 
 [build.environment]
   YARN_VERSION = "3.1.1"

website/docs/api-clients/gettingStarted.mdx renamed to website/docs/api-clients/getting-started.mdx

@@ -16,7 +16,7 @@ Generated code in production can be find on repository of the clients.
 
 ## Usage
 
-See [the getting started](/docs/api-clients/gettingStarted) page.
+See [the getting started](/docs/api-clients/getting-started) page.
 
 You can also check the [playground](/docs/automation/testing/playground) if you'd like to test clients locally.
 

website/docs/api-clients/introduction.md

@@ -8,7 +8,7 @@ Adding an API client requires a manual steps in order to setup the tooling, gene
 
 :::info
 
-Make sure to first [setup the repository tooling](/docs/automation/setupRepository) to ease your journey!
+Make sure to first [setup the repository tooling](/docs/automation/setup-repository) to ease your journey!
 
 :::
 
@@ -61,7 +61,7 @@ Below are the options you need to **make sure to define for your client**, other
 | ------------------- | :----: | :--------: | :-----------------------------: | :------------------------------------------------------------------------------------------------------------------- |
 | output              | string |   Common   | `path/to/client/client-sources` | The output path of the client.                                                                                       |
 | gitRepoId           | string |   Common   |  `algoliasearch-client-java-2`  | The name of the repository under the Algolia org.                                                                    |
-| packageName         | string |   common   |         `AlgoliaSearch`         | Name of the API package, used in [CTS](/docs/automation/testing/commonTestSuite).                                    |
+| packageName         | string |   common   |         `AlgoliaSearch`         | Name of the API package, used in [CTS](/docs/automation/testing/common-test-suite).                                  |
 | packageVersion      | string | JavaScript |             `1.2.3`             | The version you'd like to publish the first iteration of the generated client. It will be automatically incremented. |
 | utilsPackageVersion | string | JavaScript |             `0.1.2`             | The version you'd like to publish the first iteration of the utils package. It will be automatically incremented.    |
 
@@ -89,12 +89,12 @@ You can copy [an existing client caching step](https://github.com/algolia/api-cl
 
 ## 3. Generate new client
 
-> You can find all the commands in the [CLI > clients commands page](/docs/automation/CLI/clientsCommands) and [CLI > specs commands page](/docs/automation/CLI/specsCommands).
+> You can find all the commands in the [CLI > clients commands page](/docs/automation/CLI/clients-commands) and [CLI > specs commands page](/docs/automation/CLI/specs-commands).
 
 ```bash
 yarn docker generate <languageName> <clientName>
 ```
 
 ## 4. Implementing the Common Test Suite
 
-Clients needs to be tested, you can read more in the [Common Test Suite](/docs/automation/testing/commonTestSuite) guide.
+Clients needs to be tested, you can read more in the [Common Test Suite](/docs/automation/testing/common-test-suite) guide.

website/docs/automation/CLI/clientsCommands.md renamed to website/docs/automation/CLI/clients-commands.md

@@ -6,7 +6,7 @@ title: Support a new language
 
 :::info
 
-Make sure to first [setup the repository tooling](/docs/automation/setupRepository) to ease your journey!
+Make sure to first [setup the repository tooling](/docs/automation/setup-repository) to ease your journey!
 
 You will also need to have the [openapi-generator](https://openapi-generator.tech/docs/installation/) installed.
 
@@ -36,7 +36,7 @@ openapi-generator author template -g typescript-node -o templates/javascript/
 
 Add each client in the file [`openapitools.json`](https://github.com/algolia/api-clients-automation/blob/main/openapitools.json), following the others client structure.
 
-> See [`add a new client`](/docs/automation/addNewApiClient) for informations on how to structure your new client.
+> See [`add a new client`](/docs/automation/add-new-api-client) for informations on how to structure your new client.
 
 ### Algolia requirements
 
@@ -77,7 +77,7 @@ The retry strategy cannot be generated and needs to be implemented outside of th
 
 Some Algolia clients (search and recommend) targets the default appId host (`${appId}-dsn.algolia.net`, `${appId}.algolia.net`, etc.), while clients like `personalization` have their own regional `host` (`eu` | `us` | `de`).
 
-As the generator does not support reading `servers` in a spec file **yet**, hosts methods and variables are extracted with a custom script and create variables for you to use in the mustache templates, [read more here](/docs/automation/addNewApiClient#generators).
+As the generator does not support reading `servers` in a spec file **yet**, hosts methods and variables are extracted with a custom script and create variables for you to use in the mustache templates, [read more here](/docs/automation/add-new-api-client#generators).
 
 ### User Agent
 

website/docs/automation/CLI/ctsCommands.md renamed to website/docs/automation/CLI/cts-commands.md

@@ -10,18 +10,18 @@ This section hosts informations about the [API clients automation](https://githu
 
 To contribute to the repository, make sure to take a look at our guidelines and recommendations:
 
-- [Setup the repository tooling](/docs/automation/setupRepository): to install our tooling.
-  - CLI commands can be found at [CLI > specs commands](/docs/automation/CLI/specsCommands), [CLI > clients commands](/docs/automation/CLI/clientsCommands) and [CLI > CTS commands](/docs/automation/CLI/ctsCommands).
-- [Add a new client](/docs/automation/addNewApiClient): to add a new API spec to generate a client.
-- [Support a new language](/docs/automation/addNewLanguage): to add a new supported language to the API clients.
-- [Commit and Pull-request](/docs/automation/commitAndPullRequest): to see what to commit and send pull-requests.
-- [Release process](/docs/automation/releaseProcess): to see how to release API clients.
+- [Setup the repository tooling](/docs/automation/setup-repository): to install our tooling.
+  - CLI commands can be found at [CLI > specs commands](/docs/automation/CLI/specs-commands), [CLI > clients commands](/docs/automation/CLI/clients-commands) and [CLI > CTS commands](/docs/automation/CLI/cts-commands).
+- [Add a new client](/docs/automation/add-new-api-client): to add a new API spec to generate a client.
+- [Support a new language](/docs/automation/add-new-language): to add a new supported language to the API clients.
+- [Commit and Pull-request](/docs/automation/commit-and-pull-request): to see what to commit and send pull-requests.
+- [Release process](/docs/automation/release-process): to see how to release API clients.
 
 ## Testing
 
 Generated clients can be tested via the:
 
-- [Common Test Suite](/docs/automation/testing/commonTestSuite)
+- [Common Test Suite](/docs/automation/testing/common-test-suite)
 - [Playground](/docs/automation/testing/playground)
 
 ## Feedbacks

website/docs/automation/CLI/specsCommands.md renamed to website/docs/automation/CLI/specs-commands.md

@@ -54,11 +54,11 @@ yarn docker:clean
 
 Once you've successfully built and mounted the Docker image, you can now play with the repository! Read our guides on:
 
-- [How to add a new client](/docs/automation/addNewApiClient)
-- [How to add a new language](/docs/automation/addNewLanguage)
-- [Use CLI specs commands](/docs/automation/CLI/specsCommands)
-- [Use CLI clients commands](/docs/automation/CLI/clientsCommands)
-- [Use CLI Common Test Suite commands](/docs/automation/CLI/specsCommands)
+- [How to add a new client](/docs/automation/add-new-api-client)
+- [How to add a new language](/docs/automation/add-new-language)
+- [Use CLI specs commands](/docs/automation/CLI/specs-commands)
+- [Use CLI clients commands](/docs/automation/CLI/clients-commands)
+- [Use CLI Common Test Suite commands](/docs/automation/CLI/specs-commands)
 
 ## Troubleshooting
 

website/docs/automation/addNewApiClient.md renamed to website/docs/automation/add-new-api-client.md

@@ -11,7 +11,7 @@ It is automaticaly generated for all languages, from a JSON entry point.
 
 Common Test Suite requires all clients to be built.
 
-[CLI commands for the Common Test Suite](/docs/automation/CLI/ctsCommands)
+[CLI commands for the Common Test Suite](/docs/automation/CLI/cts-commands)
 
 :::
 

website/docs/automation/addNewLanguage.md renamed to website/docs/automation/add-new-language.md

@@ -8,7 +8,7 @@ All of the existing clients should have an active playground for you to test gen
 
 :::info
 
-Make sure to first [setup the repository tooling](/docs/automation/setupRepository) to ease your journey!
+Make sure to first [setup the repository tooling](/docs/automation/setup-repository) to ease your journey!
 
 :::
 

website/docs/automation/commitAndPullRequest.md renamed to website/docs/automation/commit-and-pull-request.md

@@ -10,15 +10,15 @@ const sidebars = {
       label: 'Getting Started',
       collapsed: false,
       items: [
-        'automation/setupRepository',
+        'automation/setup-repository',
         {
           type: 'category',
           label: 'CLI',
           collapsed: false,
           items: [
-            'automation/CLI/specsCommands',
-            'automation/CLI/clientsCommands',
-            'automation/CLI/ctsCommands',
+            'automation/CLI/specs-commands',
+            'automation/CLI/clients-commands',
+            'automation/CLI/cts-commands',
           ],
         },
       ],
@@ -28,24 +28,24 @@ const sidebars = {
       label: 'Contributing',
       collapsed: false,
       items: [
-        'automation/addNewApiClient',
-        'automation/addNewLanguage',
+        'automation/add-new-api-client',
+        'automation/add-new-language',
         {
           type: 'category',
           label: 'Testing',
           collapsed: false,
           items: [
-            'automation/testing/commonTestSuite',
+            'automation/testing/common-test-suite',
             'automation/testing/playground',
           ],
         },
-        'automation/commitAndPullRequest',
-        'automation/releaseProcess',
+        'automation/commit-and-pull-request',
+        'automation/release-process',
       ],
     },
   ],
   // Everything related to the generated clients usage
-  clients: ['api-clients/introduction', 'api-clients/gettingStarted'],
+  clients: ['api-clients/introduction', 'api-clients/getting-started'],
 };
 
 // eslint-disable-next-line import/no-commonjs