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

Enable the generation of documentation for extensions whose package name contains 5 specific components #18106

Merged
merged 2 commits into from
Jun 23, 2021

Conversation

yrodiere
Copy link
Member

Because I'm going to introduce an extension named quarkus-hibernate-search-orm-elasticsearch-aws. Yes that's a mouthful, but considering it's an integration into the existing quarkus-hibernate-search-orm-elasticsearch, there isn't much choice in how to name it...

The change is quite similar to 5be4cff, so I expect it should be safe?

Note I also tried the pattern ^io\\.quarkus\\.(\\w+)(?:\\.(\\w+))* as an alternative, but it doesn't work: it seems capturing groups in non-capturing groups are ignored for some reason.

yrodiere added 2 commits June 23, 2021 14:22
…ame contains 5 specific components

Because I'm going to introduce an extension named
`quarkus-hibernate-search-orm-elasticsearch-aws`...
@gsmet
Copy link
Member

gsmet commented Jun 23, 2021

@yrodiere have you made a diff of the generated doc before and after this change?

@yrodiere
Copy link
Member Author

@yrodiere have you made a diff of the generated doc before and after this change?

Doing that right now, be back with the diff in a few minutes...

@yrodiere
Copy link
Member Author

@yrodiere have you made a diff of the generated doc before and after this change?

Doing that right now, be back with the diff in a few minutes...

Done. I ran your aliases, build-fast && build-docs, both on main and on this branch. Absolutely no differences in the resulting docs/target/generated-docs.

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Cool, thanks!

@yrodiere
Copy link
Member Author

I also diffed target/asciidoc/generated/config. Here is the result: https://gist.github.com/yrodiere/14406494aebcf0e6d430646b765e13fd

As far as I can tell the differences are unrelated to my changes. All the differences are related to quarkus-amazon-common, which is a base module reused in multiple extensions, but which is not documented by itself.

Most likely these files have a different content for each build, because multiple extensions compete for their content.

@yrodiere
Copy link
Member Author

As far as I can tell the differences are unrelated to my changes.

Also, FWIW, docs/target/generated-docs/ does not have any difference, and it does include the configuration docs for every documented extension, converted to HTML.

@gsmet gsmet added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jun 23, 2021
@gsmet gsmet merged commit 141ad49 into quarkusio:main Jun 23, 2021
@quarkus-bot quarkus-bot bot added this to the 2.1 - main milestone Jun 23, 2021
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jun 23, 2021
@yrodiere yrodiere deleted the extension-5-components branch August 4, 2021 07:45
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.

2 participants