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

docs(v2): fix grammar #3428

Merged
merged 1 commit into from
Sep 10, 2020
Merged

docs(v2): fix grammar #3428

merged 1 commit into from
Sep 10, 2020

Conversation

thadguidry
Copy link
Contributor

Motivation

improve grammar about inline SVGs

Have you read the Contributing Guidelines on pull requests?

YES

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 9, 2020
@docusaurus-bot
Copy link
Contributor

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit 6b20bba

https://deploy-preview-3428--docusaurus-2.netlify.app

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Sep 10, 2020
@slorber slorber merged commit 94527b0 into facebook:master Sep 10, 2020
@slorber
Copy link
Collaborator

slorber commented Sep 10, 2020

thanks ;:)

@slorber slorber changed the title fix grammar docs(v2): fix grammar Sep 10, 2020
@maksnester
Copy link

@slorber @thadguidry I guess fixes like that should be applied to the next version by default. Now that typo is fixed in .63 docs, but not in .64 or next docs.

I was just curious how do you guys handle versioned documentation fixes and found this PR.

@slorber slorber mentioned this pull request Sep 28, 2020
@slorber
Copy link
Collaborator

slorber commented Sep 28, 2020

@maksnester this is a merge mistake, thanks for reporting it. We generally ask the contributor to update the upstram docs, not a specific version.

I've ported the changes here: #3493

In the future we'll likely have more options to customize the editUrl, so that you can nudge users to do the right thing.
#3152

@thadguidry thadguidry deleted the patch-2 branch September 28, 2020 17:24
@thadguidry
Copy link
Contributor Author

@slorber it's not clear enough then on the CONTRIBUTING.md file. https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md

@slorber
Copy link
Collaborator

slorber commented Sep 28, 2020

@thadguidry this doc is quite old and we should also consider that there is v1 and v2 in the same repo. We'll likely update it in the future once v2 is officially released

In the meantime, if you have ideas on how we could improve this doc, PRs are welcome

@thadguidry
Copy link
Contributor Author

@slorber I don't know what the best context would be to put into the CONTRIBUTING.md document, but I would suggest that perhaps since v1 and v2 are in the same repo, then mention that in the document and then have someone on your team type up a separate paragraph about "Contributing to Docs for v2" which is the critical point for many using and helping test v2 at this point in time.

@slorber
Copy link
Collaborator

slorber commented Sep 29, 2020

@thadguidry we are a small team (basically only me fulltime) and I should focus on shipping i18n support. If you really think something is important, submitting a PR is the most effective way. I agree this is important, but can't do a full docs and contributing docs review right now, as shipping i18n is even more important, and I'm coming back from holidays I have like 100 new issues opened in my todolist to check :)

We'll definitively improve this contributing experience, and also structure better the monorepo, and the v2 docs, but if nobody wants to help improve it right now, it'll wait until i18n is shipped and when v2 is in beta or RC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants