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 an "Edit this page" link to each page #49

Open
LenzGr opened this issue Dec 8, 2021 · 4 comments
Open

Add an "Edit this page" link to each page #49

LenzGr opened this issue Dec 8, 2021 · 4 comments

Comments

@LenzGr
Copy link
Contributor

LenzGr commented Dec 8, 2021

Having a quick and direct way to make small changes to a web page's content further lowers the barrier for getting improvement suggestions to the documentation and web site. Have you considered adding a feature that provide an "Edit" option that would open the Markdown file on github in Edit mode?

@zdover23
Copy link
Collaborator

zdover23 commented Dec 8, 2021

Lenz,

I think this is a fine suggestion, but I also think that there should be a English-grammar-savvy gatekeeper who has veto power over any suggestions made through such a channel as the one you propose. I realize in typing this out just how self-serving this suggestion might seem.

@damien-lemoal
Copy link
Contributor

Having a quick and direct way to make small changes to a web page's content further lowers the barrier for getting improvement suggestions to the documentation and web site. Have you considered adding a feature that provide an "Edit" option that would open the Markdown file on github in Edit mode?

Well, "easy" is all relative... Personally, I find working with git cli + vim edit files far easier than any of the obscure GitHub web interface :)

Docusaurus has a "edit page" button but I disabled it for now. I need to have a look at how that is working and what happens in github when it is being used. Based on that, we can probably enable it, as long as changes come in the form of PRs that can be reviewed.

Will try to have a look later today or tomorrow.

@LenzGr
Copy link
Contributor Author

LenzGr commented Dec 10, 2021

I think this is a fine suggestion, but I also think that there should be a English-grammar-savvy gatekeeper who has veto power over any suggestions made through such a channel as the one you propose.

Fair point, but reviewing and approving a pull request prior to merging it should be best practice anyway, no?

@damien-lemoal
Copy link
Contributor

Having a quick and direct way to make small changes to a web page's content further lowers the barrier for getting improvement suggestions to the documentation and web site. Have you considered adding a feature that provide an "Edit" option that would open the Markdown file on github in Edit mode?

Well, "easy" is all relative... Personally, I find working with git cli + vim edit files far easier than any of the obscure GitHub web interface :)

Docusaurus has a "edit page" button but I disabled it for now. I need to have a look at how that is working and what happens in github when it is being used. Based on that, we can probably enable it, as long as changes come in the form of PRs that can be reviewed.

Will try to have a look later today or tomorrow.

Late with this. Will try harder to have a look :)

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

3 participants