diff --git a/README.md b/README.md index 36aee0b906..12ac269fbd 100644 --- a/README.md +++ b/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 ``` -[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 yarn docker generate ``` -[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)). diff --git a/netlify.toml b/netlify.toml index 0a416113d6..37523735c1 100644 --- a/netlify.toml +++ b/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" diff --git a/website/docs/api-clients/gettingStarted.mdx b/website/docs/api-clients/getting-started.mdx similarity index 100% rename from website/docs/api-clients/gettingStarted.mdx rename to website/docs/api-clients/getting-started.mdx diff --git a/website/docs/api-clients/introduction.md b/website/docs/api-clients/introduction.md index 8171c6fe31..0b06e5b1bb 100644 --- a/website/docs/api-clients/introduction.md +++ b/website/docs/api-clients/introduction.md @@ -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. diff --git a/website/docs/automation/CLI/clientsCommands.md b/website/docs/automation/CLI/clients-commands.md similarity index 100% rename from website/docs/automation/CLI/clientsCommands.md rename to website/docs/automation/CLI/clients-commands.md diff --git a/website/docs/automation/CLI/ctsCommands.md b/website/docs/automation/CLI/cts-commands.md similarity index 100% rename from website/docs/automation/CLI/ctsCommands.md rename to website/docs/automation/CLI/cts-commands.md diff --git a/website/docs/automation/CLI/specsCommands.md b/website/docs/automation/CLI/specs-commands.md similarity index 100% rename from website/docs/automation/CLI/specsCommands.md rename to website/docs/automation/CLI/specs-commands.md diff --git a/website/docs/automation/addNewApiClient.md b/website/docs/automation/add-new-api-client.md similarity index 95% rename from website/docs/automation/addNewApiClient.md rename to website/docs/automation/add-new-api-client.md index 7f61a1a233..2120d16df7 100644 --- a/website/docs/automation/addNewApiClient.md +++ b/website/docs/automation/add-new-api-client.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,7 +89,7 @@ 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 @@ -97,4 +97,4 @@ yarn docker generate ## 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. diff --git a/website/docs/automation/addNewLanguage.md b/website/docs/automation/add-new-language.md similarity index 94% rename from website/docs/automation/addNewLanguage.md rename to website/docs/automation/add-new-language.md index 8457d994e2..7cefc4bc69 100644 --- a/website/docs/automation/addNewLanguage.md +++ b/website/docs/automation/add-new-language.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 diff --git a/website/docs/automation/commitAndPullRequest.md b/website/docs/automation/commit-and-pull-request.md similarity index 100% rename from website/docs/automation/commitAndPullRequest.md rename to website/docs/automation/commit-and-pull-request.md diff --git a/website/docs/automation/introduction.md b/website/docs/automation/introduction.md index ed9b6f807a..57efcf3d95 100644 --- a/website/docs/automation/introduction.md +++ b/website/docs/automation/introduction.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 diff --git a/website/docs/automation/releaseProcess.md b/website/docs/automation/release-process.md similarity index 100% rename from website/docs/automation/releaseProcess.md rename to website/docs/automation/release-process.md diff --git a/website/docs/automation/setupRepository.md b/website/docs/automation/setup-repository.md similarity index 84% rename from website/docs/automation/setupRepository.md rename to website/docs/automation/setup-repository.md index 7418b3de11..d63b4b8ed0 100644 --- a/website/docs/automation/setupRepository.md +++ b/website/docs/automation/setup-repository.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 diff --git a/website/docs/automation/testing/commonTestSuite.md b/website/docs/automation/testing/common-test-suite.md similarity index 99% rename from website/docs/automation/testing/commonTestSuite.md rename to website/docs/automation/testing/common-test-suite.md index 27edafd8cb..e04a44ccf1 100644 --- a/website/docs/automation/testing/commonTestSuite.md +++ b/website/docs/automation/testing/common-test-suite.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) ::: diff --git a/website/docs/automation/testing/playground.md b/website/docs/automation/testing/playground.md index 57da73af76..e002c9a14e 100644 --- a/website/docs/automation/testing/playground.md +++ b/website/docs/automation/testing/playground.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! ::: diff --git a/website/sidebars.js b/website/sidebars.js index b32f4f9f75..1f8f1ec575 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -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