s434730/RandomSec
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Creation of the How-To Contribute to docs (#2614)

Browse Source 
* First creation of the How-To Contribute to docs

First creation of the How-To Contribute to docs file, and transfer of the How-To Build from source from the old wiki.

* Spelling errors and mistakes

Co-authored-by: Kush Trivedi <44091822+kushthedude@users.noreply.github.com>

* Change * for &ast;

Change * for &ast;

* Update contribute_to_or.md

Small change

* Merge technical documentation

Co-authored-by: Kush Trivedi <44091822+kushthedude@users.noreply.github.com>
Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
This commit is contained in:
Antoine Beaubien 2021-01-27 03:01:37 -05:00 committed by GitHub
parent a421447a8f
commit a2ed9d586a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/docs/technical-reference/contributing.md
View File

@ -13,7 +13,35 @@ If you need to file a bug or request a feature, [create an Issue in the OpenRefi
- [Try the user manual](/)
- [post to our OpenRefine mailing list](http://groups.google.com/group/openrefine/)
## Your first pull request
## Contributing to the documentation
We use [Docusaurus](https://docusaurus.io/) for our docs. For small documentation changes, you should be able to edit the Markdown files directly and submit them as a pull request. A preview of the docs will be generated automatically. But it is also
possible to preview your changes locally. Assuming you have [Node.js](https://nodejs.org/en/download/) installed (which includes npm), you can install Docusaurus with:
You will need to install [Yarn](https://yarnpkg.com/getting-started/install) before you can build the site.
```sh
npm install -g yarn
```
Once you have installed yarn, navigate to docs directory & set-up the dependencies.
```sh
cd docs
yarn
```
Once this is done, generate the docs with:
```sh
yarn build
```
You can also spin a local web server to serve the docs for you, with auto-refresh when you edit the source files, with:
```sh
yarn start
```
## Your first code pull request
This describes the overall steps to your first code contribution in OpenRefine. If you have trouble with any of these steps feel free to reach out on the [developer mailing list](https://groups.google.com/forum/#!forum/openrefine-dev) or the [Gitter channel](https://gitter.im/OpenRefine/OpenRefine).