loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-12 12:40:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs typos (#6478)

Browse Source
This commit is contained in:
Frieder Bluemle 2020-05-31 08:03:12 -07:00 committed by GitHub
parent 39eb32ec27
commit a96e783f06
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/faq-contributing.md
View File

@ -45,9 +45,9 @@ Please refer to http://rypress.com/tutorials/git/rebasing, or follow the steps b
(To setup `upstream` pointing to the official repo, please run `git remote add upstream https://github.com/openapitools/openapi-generator.git`)
## How can I update commits that are not linked to my Github account?
## How can I update commits that are not linked to my GitHub account?
Please refer to https://stackoverflow.com/questions/3042437/how-to-change-the-commit-author-for-one-specific-commit or you can simply add the email address in the commit as your secondary email address in your Github account.
Please refer to https://stackoverflow.com/questions/3042437/how-to-change-the-commit-author-for-one-specific-commit or you can simply add the email address in the commit as your secondary email address in your GitHub account.
## Any useful git tips to share?

4
docs/installation.md
View File

@ -8,11 +8,11 @@ Installing OpenAPI Generator's CLI tool allows users to generate all available g
Some of the following are cross-platform options and some are not, these are called out where possible.
## NPM
## npm
> **Platform(s)**: Linux, macOS, Windows
The [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) is cross-platform wrapper around the .jar artifact. It works by providing a CLI wrapper atop the JAR's command line options. This gives a simple interface layer which normalizes usage of the command line across operating systems, removing some differences in how options or switches are passed to the tool (depending on OS).
The [npm package wrapper](https://github.com/openapitools/openapi-generator-cli) is cross-platform wrapper around the .jar artifact. It works by providing a CLI wrapper atop the JAR's command line options. This gives a simple interface layer which normalizes usage of the command line across operating systems, removing some differences in how options or switches are passed to the tool (depending on OS).
**Install** the latest version of the tool globally, exposing the CLI on the command line:
```bash

4
docs/integration.md
View File

@ -2,7 +2,7 @@
id: integrations
title: Workflow Integrations
---
## Workflow Integration (Maven, Github, CI/CD)
## Workflow Integration (Maven, GitHub, CI/CD)
### Gradle Integration
@ -39,7 +39,7 @@ To push the auto-generated SDK to GitHub, we provide `git_push.sh` to streamline
-i modules/openapi-generator/src/test/resources/2_0/petstore.json -g perl \
--git-user-id "wing328" \
--git-repo-id "petstore-perl" \
--release-note "Github integration demo" \
--release-note "GitHub integration demo" \
-o /var/tmp/perl/petstore
```
3) Push the SDK to GitHub

4
website/src/pages/index.js
View File

@ -127,11 +127,11 @@ const callouts = [
{
id: 'try',
imageUrl: 'img/tools/npm.svg',
title: <>Try via NPM</>,
title: <>Try via npm</>,
content: (
<>
<p>
The <a href="https://github.com/openapitools/openapi-generator-cli" className="href">NPM package
The <a href="https://github.com/openapitools/openapi-generator-cli" className="href">npm package
wrapper</a> is cross-platform wrapper around the .jar artifact.
</p>
<p>