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: update versions, fix links, remove broken camel.xml, update download counts #19356

Merged
merged 4 commits into from
Aug 15, 2024

Conversation

martin-mfg
Copy link
Contributor

A few small documentation improvements; mainly:

  • update OpenAPI Generator version in several places
  • fix links in the Readme
  • remove modules/openapi-generator-maven-plugin/examples/camel.xml, because the OpenAPI Generator version was old, and the generator name was wrong, and the generated code doesn't compile (and then I didn't check further)
  • update download stats for npm and docker

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

... because it has the wrong generator version, it has the wrong generator name (should be "java-camel"), the generated code doesn't compile - and then I didn't check further
@wing328
Copy link
Member

wing328 commented Aug 15, 2024

thanks for the PR to clean up the outdated entries in the doc

@wing328 wing328 merged commit 05c1093 into OpenAPITools:master Aug 15, 2024
13 checks passed
@wing328 wing328 added this to the 7.8.0 milestone Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants