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

Add more anchors in the properties appendix #16267

Closed
garyrussell opened this issue Mar 19, 2019 · 11 comments
Closed

Add more anchors in the properties appendix #16267

garyrussell opened this issue Mar 19, 2019 · 11 comments
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@garyrussell
Copy link
Contributor

garyrussell commented Mar 19, 2019

Thanks for adding anchors to the appendix (#8237).

This is a big improvement, but I wonder if it could be a bit more granular; for example Integration Properties covers many technologies and properties.

It would be nice if we could jump directly to rabbitmq or kafka instead of having to scroll past all the other properties.

@snicoll
Copy link
Member

snicoll commented Jul 16, 2019

I can see two ways we could fix this issue and both seems to lead to the creation of more tables. If we want to do this in a global fashion, perhaps our current description could have the notion of "sub-sections" so that we could do something like this:

.addSection("integration")
    .withSection("spring.activemq").withSection("spring.artemis").withSection("spring.batch") ...

That would create one sub-section under the current integration section with the same naming pattern (i.e. "spring.activemq properties") and a dedicated anchor.

If we don't want to go down that route, we could split things up a bit and just remove the high-level section and just listing the prefix one by one. In other words, remove the integration section and list only the prefixes. Doc output should help us decide what's best probably.

@garyrussell
Copy link
Contributor Author

garyrussell commented Sep 10, 2020

It is not just the Integration section; I see a similar problem in the Data section with hundreds of properties covering many technologies.

spring-guides/gs-messaging-redis#20 (comment)

@Buzzardo
Copy link

It would be good to be able to link directly to a property from other documents. You need not have a heading for each anchor. Inline anchors can go anywhere.

@wilkinsona
Copy link
Member

I've started working on something for this that will make each individual property linkable.

@wilkinsona wilkinsona self-assigned this Sep 11, 2020
@wilkinsona wilkinsona modified the milestones: 2.x, 2.4.x Sep 11, 2020
@wilkinsona wilkinsona modified the milestones: 2.4.x, 2.4.0-M3 Sep 11, 2020
@wilkinsona
Copy link
Member

Each property in the 2.4.0 snapshot docs now has an anchor and is a clickable link. For example, here's spring.redis.host.

@garyrussell
Copy link
Contributor Author

Sweet - thanks @wilkinsona

@Buzzardo
Copy link

Very nice. Thanks, @wilkinsona :)

@philwebb philwebb reopened this Sep 12, 2020
@philwebb
Copy link
Member

Reopening because I'm afraid on Firefox it doesn't look the best. We might need some doc css updates.

Screen Shot 2020-09-11 at 5 40 01 PM

@philwebb
Copy link
Member

Although I agree, it's a very nice feature!

@wilkinsona
Copy link
Member

It looks the same in Safari, I'm just less discerning than you. I think the main difference is that there's now a box drawn round each key. I think the CSS does that to any link where the text is monospaced (wrapped in `).

@wilkinsona
Copy link
Member

spring-io/spring-doc-resources#48 needs to be addressed to fix this. We'll live with it in the meantime.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

6 participants