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

Please add [edit this page] link to all EUI doc pages #3767

Closed
nyurik opened this issue Jul 18, 2020 · 3 comments
Closed

Please add [edit this page] link to all EUI doc pages #3767

nyurik opened this issue Jul 18, 2020 · 3 comments
Labels
design decision documentation Issues or PRs that only affect documentation - will not need changelog entries

Comments

@nyurik
Copy link
Contributor

nyurik commented Jul 18, 2020

Many Elastic and other FOSS projects include edit this page links on each documentation page, allowing users to contribute minor improvements without too much effort -- e.g. using GitHub's online editor to edit and create a PR. Could something like this be added to EUI as well? Thanks!

Somewhat related to #3508

@snide
Copy link
Contributor

snide commented Jul 18, 2020

I'm not so sure about this one. We get a pretty sizable amount of community contributions already, and usually those "edit this page" style links are for highly textual documentation, where EUI's docs tend to be pretty complicated (multiple pages to make a single view) and visual.

I'm worried it would distract from the content of the page, which already are pretty busy.

@snide snide added design decision documentation Issues or PRs that only affect documentation - will not need changelog entries labels Jul 18, 2020
@nyurik
Copy link
Contributor Author

nyurik commented Jul 18, 2020

@snide I tend to see a lot of those at the bottom of the page, e.g. here (bottom left), or take a look at the elastic search docs -- on the side and semi-transparent (btw, asciidoc is even worse at their file-to-page structure). It could even be show-on-mouseover style and hidden otherwise. I think it makes the site more welcoming to the user contributions, encouraging users to participate than just to use.

@chandlerprall
Copy link
Contributor

We discussed as a team and decided not to implement this - at least for now. We don't believe most edits to our docs can really exist as a single-file change of copy (with exceptions for spelling/grammatical issues). As a page is comprised of sections containing examples, each with a separate code file, it would be difficult to know which of these an edit link should target.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design decision documentation Issues or PRs that only affect documentation - will not need changelog entries
Projects
None yet
Development

No branches or pull requests

3 participants