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 "edit" feature to Docusaurus pages #5492

Merged
merged 1 commit into from
Oct 21, 2018

Conversation

amyrlam
Copy link
Contributor

@amyrlam amyrlam commented Oct 20, 2018

Adds "edit" button on the page, making it easy to contribute to docs. See: https://docusaurus.io/docs/en/site-config#editurl-string

IS:
edit-option

@selbekk
Copy link
Contributor

selbekk commented Oct 21, 2018

Looks great!

@Timer
Copy link
Contributor

Timer commented Oct 21, 2018

What happens if the user isn't a collaborator? Does it automatically fork to their account and reroute the URL?

@Timer Timer added this to the 2.0.6 milestone Oct 21, 2018
@iansu
Copy link
Contributor

iansu commented Oct 21, 2018

@Timer I'm pretty sure that's how this works. I've used GitHub's editing functionality to contribute to the docs of other projects in the past and I think it created a fork for me first. I'm pretty sure it also walks you though the process of turning your edits in your fork into a PR.

@iansu
Copy link
Contributor

iansu commented Oct 21, 2018

I just tried this on the Jest README:

screenshot 2018-10-21 15 48 52

@Timer Timer merged commit 07ff5a0 into facebook:master Oct 21, 2018
@amyrlam amyrlam deleted the amy/add-docusaurus-edit branch October 21, 2018 22:01
@Timer Timer modified the milestones: 2.0.6, 2.1 Oct 22, 2018
nate770 pushed a commit to ONTW/create-react-app that referenced this pull request Oct 30, 2018
@lock lock bot locked and limited conversation to collaborators Jan 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants