Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] publish documentation for the generators #932

Merged
merged 2 commits into from
Aug 31, 2018

Conversation

jmini
Copy link
Member

@jmini jmini commented Aug 30, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.3.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language. @OpenAPITools/generator-core-team @OpenAPITools/openapi-generator-collaborators

Description of the PR

Fixes #441

The documentation (cli help pages) are published under docs/generators.

3 new scripts are introduced:

  • bin/utils/export_generators_readme.sh updates the readme: docs/generators/README.md
  • bin/utils/export_generator.sh <generator_name> updates the file: docs/generators/<generator_name>.md
  • bin/utils/export_docs_generators.sh updates the complete folder docs/generators

This will stay up to data whit the ensure-up-to-date script (see #80)

@bjgill bjgill modified the milestone: 3.2.3 Aug 30, 2018
@etherealjoy
Copy link
Contributor

@jmini
I am missing the options which are exported by the DefaultCodegen like modelNamePrefix for example.

@cbornet cbornet added this to the 3.3.0 milestone Aug 30, 2018
@jimschubert
Copy link
Member

Wrapping in the code blocks makes long descriptions overflow.

I'd recommend as a future improvement to convert options to html definition lists and html escape descriptions.

@jmini
Copy link
Member Author

jmini commented Aug 30, 2018

I am missing the options which are exported by the DefaultCodegen like modelNamePrefix for example.

@etherealjoy : nice catch those are the exports produced by our CLI. Please file a separate issue for that.

I'd recommend as a future improvement to convert options to html definition lists and html escape descriptions.

@jimschubert: I totally agree with you. The current output is better than nothing.

It is a quick win by reusing the CLI ouput and doing small search and replace changes with sed to get a Markdown file that can be displayed in the GitHub and that have some links (for navigation).

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I'm sure users (especially the new one) will find the doc helpful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants