misc: add License to the documentation #3473
Conversation
Added the MIT License shield and fixed grammatical errors in the documentation.
Update CODE_OF_CONDUCT.md
|
Deploy preview for docusaurus-2 ready! Built without sensitive environment variables with commit fc4e83b |
|
Thanks @muskanvk @JoelMarcey any opinion on this PR? |
slorber
changed the title
CODE_OF_CONDUCT.md
Outdated
| @@ -1,3 +1,39 @@ | |||
| # Code of Conduct | |||
|
|
|||
| Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.fb.com/codeofconduct/) so that you can understand what actions will and will not be tolerated. | |||
There was a problem hiding this comment.
I'm not sure it's a good idea to remove this link here.
There was a problem hiding this comment.
We don't want to remove this link and dump the text here because it can get outdated. We rather have a centralized place for the most updated Code of Conduct. Please revert all changes to this file.
There was a problem hiding this comment.
Sure Thing, I get what you are saying. I"ll do it.
CODE_OF_CONDUCT.md
Outdated
| @@ -1,3 +1,39 @@ | |||
| # Code of Conduct | |||
|
|
|||
| Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.fb.com/codeofconduct/) so that you can understand what actions will and will not be tolerated. | |||
There was a problem hiding this comment.
We don't want to remove this link and dump the text here because it can get outdated. We rather have a centralized place for the most updated Code of Conduct. Please revert all changes to this file.
There was a problem hiding this comment.
Hi all 👋 - I am a little confused on this PR. It talks about a change to the CODE_OF_CONDUCT file (which we shouldn't do by the way, since that is consistent across our open source projects -- unless there is an obvious, showstopping error), but in the PR, I only see a change to the README.
| @@ -11,15 +11,16 @@ | |||
| <a href="https://circleci.com/gh/facebook/docusaurus"><img src="https://img.shields.io/circleci/build/github/facebook/docusaurus.svg" alt="CircleCI status"></a> | |||
| <a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a> | |||
| <a href="https://discord.gg/docusaurus"><img src="https://img.shields.io/discord/102860784329052160.svg" align="right" alt="Discord Chat" /></a> | |||
| <a href="https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"></a> | |||
| <a href= "https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"></a> | |||
| <a href="#license"><img src="https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=ff0000"></a> | |||
There was a problem hiding this comment.
What is this badge for?
There was a problem hiding this comment.
Hi, I made changes to the code of coduct earlier. However, while reviewing, I was asked not to change the code of conduct(which I wasn't aware about) so the changes made to the code of conduct have been reverted.
Secondly, this shows the license of the product.
yangshun
changed the title
slorber
added
the
pr: documentation
* Update README.md Added the MIT License shield and fixed grammatical errors in the documentation. * Update CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md * Update CODE_OF_CONDUCT.md
Motivation
I had been using Docusaurus for many days days and today I saw this repo so I thought to contribute so that more new comers are encouraged to do so.
Have you read the Contributing Guidelines on pull requests?
Yes