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

Create a stable way to link to property documentation #98

Open
keith-turner opened this issue Jul 12, 2018 · 1 comment
Open

Create a stable way to link to property documentation #98

keith-turner opened this issue Jul 12, 2018 · 1 comment

Comments

@keith-turner
Copy link
Contributor

To support linking to property documentation from Javadocs, it would be nice if the website offered stable way to do this. For example the following link could show the docs for the table.scan.dispatcher property.

https://apache.accumulo.org/docs/property/table.scan.dispatcher

Could start off with this redirecting to the docs for the latest version and change the behavior over time.
For example, it could link to the the docs for different versions of a prop and show the description from the latest version.

@ctubbsii
Copy link
Member

ctubbsii commented Nov 1, 2022

There's a high maintenance cost to writing Jekyll plugins to do this automatically. Doing this manually for each property is hugely error prone and a lot of tedious work. Either way, the end result would be a ton of static pages with http redirects that create more work for the user's browser, and I'm not sure there's much value to doing this beyond what we already get with: https://accumulo.apache.org/docs/2.x/configuration/server-properties#table_scan_dispatcher

I don't think doing this is practical.

Maybe this could be done with some sort of Bootstrap UI element, powered by JavaScript on the page, and using http anchors (like we use today) for a persistent link directly to a tab for a specific property, or something... but that's not a lot better than what we have today.

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

No branches or pull requests

2 participants