From d02d406b54201cbd22c7fbaf3ac96f7a8dc49cf0 Mon Sep 17 00:00:00 2001 From: Frank Kilcommins Date: Wed, 16 Oct 2024 10:05:06 +0100 Subject: [PATCH] chore(repo): fix documentation typos --- README.md | 2 +- docs/generators-configuration.md | 4 +++- docs/generators.md | 4 ++-- docs/versioning.md | 12 +++--------- docs/workflow-integration.md | 2 +- 5 files changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2d5fa2bf70c..2bdbd2972c9 100644 --- a/README.md +++ b/README.md @@ -271,4 +271,4 @@ When code is generated from this project, it shall be considered **AS IS** and o ## Thank You -💚💚💚 We'd like to give a big shout our to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, [authoring templates](./docs/template-creators.md), or crafting useful [content](./docs/public-content.md) for others to benefit from. 💚💚💚 +💚💚💚 We'd like to give a big shout out to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, [authoring templates](./docs/template-creators.md), or crafting useful [content](./docs/public-content.md) for others to benefit from. 💚💚💚 diff --git a/docs/generators-configuration.md b/docs/generators-configuration.md index db85239ae58..71eb2eb1981 100644 --- a/docs/generators-configuration.md +++ b/docs/generators-configuration.md @@ -30,7 +30,9 @@ and `config.json` contains the following as an example: ``` Supported config options can be different per language. Running `config-help -l {lang}` will show available options. -**These options are applied via configuration file (e.g. config.json) or by passing them with `java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}`**. (If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it) +**These options are applied via configuration file (e.g. config.json) or by passing them with `java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}`**. + +> If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it. ```sh java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java diff --git a/docs/generators.md b/docs/generators.md index d87580b21ad..2bcf11961ae 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -17,7 +17,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \ -o output/myLibrary -n myClientCodegen -p com.my.company.codegen ``` -This will write, in the folder `output/myLibrary`, all the files you need to get started, including a `README.md. Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic. +This will write, in the folder `output/myLibrary`, all the files you need to get started, including a `README.md`. Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic. You would then compile your library in the `output/myLibrary` folder with `mvn package` and execute the codegen like such: @@ -51,7 +51,7 @@ to the code generator like this: -i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json ``` -Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane. +Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane ✈️. ## Ignore file format diff --git a/docs/versioning.md b/docs/versioning.md index c579378137b..02b83f185f6 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -1,10 +1,10 @@ -## Versioning +# Versioning Both 2.X and 3.X version lines of Swagger Codegen are available and are independently maintained. **NOTE:** version 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids. -### Swagger Codegen 2.X +## Swagger Codegen 2.X ||| |----|-----| @@ -24,7 +24,7 @@ dependency example: ``` -### Swagger Codegen 3.X ([`3.0.0` branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)) +## Swagger Codegen 3.X ||| |----|-----| @@ -43,9 +43,3 @@ dependency example: 3.0.61 ``` - - -(for main ReadMe) -[Online generator of version 3.X](https://github.com/swagger-api/swagger-codegen/tree/3.0.0#online-generators) supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications. - - diff --git a/docs/workflow-integration.md b/docs/workflow-integration.md index 0c001136ba3..08a72739990 100644 --- a/docs/workflow-integration.md +++ b/docs/workflow-integration.md @@ -1,4 +1,4 @@ -# Worklfow Integrations +# Workflow Integrations ## Maven Integration