Skip to content

Commit d02d406

Browse files
frankkilcomminsfrantuma
authored andcommitted
chore(repo): fix documentation typos
1 parent 327873b commit d02d406

File tree

5 files changed

+10
-14
lines changed

5 files changed

+10
-14
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -271,4 +271,4 @@ When code is generated from this project, it shall be considered **AS IS** and o
271271

272272
## Thank You
273273

274-
💚💚💚 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. 💚💚💚
274+
💚💚💚 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. 💚💚💚

docs/generators-configuration.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ and `config.json` contains the following as an example:
3030
```
3131

3232
Supported config options can be different per language. Running `config-help -l {lang}` will show available options.
33-
**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)
33+
**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}`**.
34+
35+
> 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.
3436
3537
```sh
3638
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java

docs/generators.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \
1717
-o output/myLibrary -n myClientCodegen -p com.my.company.codegen
1818
```
1919

20-
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.
20+
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.
2121

2222
You would then compile your library in the `output/myLibrary` folder with `mvn package` and execute the codegen like such:
2323

@@ -51,7 +51,7 @@ to the code generator like this:
5151
-i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json
5252
```
5353

54-
Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane.
54+
Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane ✈️.
5555

5656
## Ignore file format
5757

docs/versioning.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Versioning
1+
# Versioning
22

33
Both 2.X and 3.X version lines of Swagger Codegen are available and are independently maintained.
44

55
**NOTE:** version 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids.
66

7-
### Swagger Codegen 2.X
7+
## Swagger Codegen 2.X
88

99
|||
1010
|----|-----|
@@ -24,7 +24,7 @@ dependency example:
2424
</dependency>
2525
```
2626

27-
### Swagger Codegen 3.X ([`3.0.0` branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0))
27+
## Swagger Codegen 3.X
2828

2929
|||
3030
|----|-----|
@@ -43,9 +43,3 @@ dependency example:
4343
<version>3.0.61</version>
4444
</dependency>
4545
```
46-
47-
48-
(for main ReadMe)
49-
[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.
50-
51-

docs/workflow-integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Worklfow Integrations
1+
# Workflow Integrations
22

33
## Maven Integration
44

0 commit comments

Comments
 (0)