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

Added anchors to configuration keys and sections #4940

Merged
merged 2 commits into from
Oct 29, 2019

Conversation

FroMage
Copy link
Member

@FroMage FroMage commented Oct 28, 2019

As requested by @dmlloyd and @maxandersen

@FroMage FroMage requested a review from machi1990 October 28, 2019 17:08
.replaceAll("[Ŵ]", "W")
.replaceAll("[ÝŶŸ]", "Y")
.replaceAll("[ŹŽŻ]", "Z")
.replaceAll("[ß]", "ss");
Copy link
Member

Choose a reason for hiding this comment

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

Very... thorough :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I took this from a French source with years of experience dealing with I18n ;)

/**
* Generate configuration keys in table format.
* Generated table will contain a key column that points to the long descriptive format.
*
* @param configDocItems
*/
@Override
public void format(Writer writer, List<ConfigDocItem> configDocItems) throws IOException {
public void format(Writer writer, boolean useAnchorPrefixes, List<ConfigDocItem> configDocItems) throws IOException {
Copy link
Member

Choose a reason for hiding this comment

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

Is there any reason we can't generate anchors all the time?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we do, but they don't need a prefix if we're generating a single page.

@geoand
Copy link
Contributor

geoand commented Oct 28, 2019

CI needs some love :)

@machi1990
Copy link
Member

machi1990 commented Oct 28, 2019

CI needs some love :)

Might be related to the fact that
agroal, reactive-mysql-client, and reactive-pg-client extensions share the same config keys datasource.url, datasource.username ...

@FroMage
Copy link
Member Author

FroMage commented Oct 29, 2019

Ah, I didn't think of the fact that one doc file can include two config files with the same keys. Lemme find a fix.

@FroMage FroMage force-pushed the all-config-docs-anchors branch from 02886e4 to 31bf87b Compare October 29, 2019 10:28
@FroMage
Copy link
Member Author

FroMage commented Oct 29, 2019

Hopefully fixed, and rebased on master. Let's wait for CI.

@stuartwdouglas stuartwdouglas added this to the 0.27.0 milestone Oct 29, 2019
@stuartwdouglas stuartwdouglas merged commit 549fb63 into quarkusio:master Oct 29, 2019
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.

5 participants