Skip to content

Commit 05773f5

Browse files
authored
Merge pull request #294 from plotly/fix-versions
Update README.md
2 parents 4b2733d + fbb86ec commit 05773f5

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,35 @@
55
Plotly welcomes contributions to its [open-source graphing libraries documentation](https://plotly.com/graphing-libraries) from its community of users.
66

77
This repository mainly serves:
8-
- Plotly's graphing libraries documentation index page at https://plotly.com/graphing-libraries.
8+
- Plotly's graphing libraries documentation index page at https://plotly.com/graphing-libraries.
99

1010
- Plotly's JavaScript graphing library documentation at https://plotly.com/javascript
11-
- Please be aware that **only the content of Plotly's JavaScript graphing library documentation** (hosted at https://plotly.com/javascript) is contained in this repository. You can find the content in the `_posts/plotly_js` directory.
11+
- Please be aware that **only the content of Plotly's JavaScript graphing library documentation** (hosted at https://plotly.com/javascript) is contained in this repository. You can find the content in the `_posts/plotly_js` directory.
1212
- For information about editing **plotly.js** documentation [click here](https://github.com/plotly/graphing-library-docs/blob/master/_posts/plotly_js/README.md).
1313

1414
- Plotly's Python graphing library documentation at https://plotly.com/python
15-
- The content for Plotly's Python graphing library documentation (hosted at https://plotly.com/python) **IS NOT** contained in this repository. It is contained in the `plotly.py` repository at https://github.com/plotly/plotly.py/tree/master/doc and is cloned into this repository at build time.
15+
- The content for Plotly's Python graphing library documentation (hosted at https://plotly.com/python) **IS NOT** contained in this repository. It is contained in the `plotly.py` repository at https://github.com/plotly/plotly.py/tree/master/doc and is cloned into this repository at build time.
1616
- For information about editing **plotly.py** documentation [click here](https://github.com/plotly/plotly.py/blob/master/doc/README.md).
1717

1818
- Plotly's R graphing library documentation at https://plotly.com/r
19-
- The content for Plotly's R graphing library documentation (hosted at https://plotly.com/r) **IS NOT** contained in this repository. It is contained in the `plotly.r-docs` repository at https://github.com/plotly/plotly.r-docs/ and is cloned into this repository at build time.
19+
- The content for Plotly's R graphing library documentation (hosted at https://plotly.com/r) **IS NOT** contained in this repository. It is contained in the `plotly.r-docs` repository at https://github.com/plotly/plotly.r-docs/ and is cloned into this repository at build time.
2020
- For information about editing Plotly's **R** documentation [click here](https://github.com/plotly/plotly.r-docs/blob/master/README.md).
2121

2222
## Contribute Quickly to Plotly's JavaScript Graphing Library Documentation
23-
23+
2424
To quickly make a contribution to Plotly's JavaScript graphing libraries documentation, simply submit a pull request with the change you would like to suggest.
2525

2626
The easiest way to do this is to follow the `Edit this page on GitHub` link at the top right of the page you are interested in contributing to:
2727

2828
![Screen Shot 2020-01-07 at 12 45 39 PM](https://user-images.githubusercontent.com/1557650/71916356-bfe53800-314b-11ea-92b6-eb763037f6d5.png)
2929

30-
**Note:** You don't have to worry about breaking the site when you submit a pull request!** This is because your change will not be merged to production immediately. A Plotly team member will first perform a code review on your pull request.
30+
**Note:** You don't have to worry about breaking the site when you submit a pull request!** This is because your change will not be merged to production immediately. A Plotly team member will first perform a code review on your pull request.
3131

3232
## How To Get The Application Working Locally
3333

34-
For more extensive changes to Ploty's JavaScript documentation, we suggest getting the Jekyll application which builds the site to run locally so that you can test your changes as you develop them.
34+
For more extensive changes to Ploty's JavaScript documentation, we suggest getting the Jekyll application which builds the site to run locally so that you can test your changes as you develop them.
3535

36-
This involves cloning the repository and installing its dependencies: [Git](https://git-scm.com/), [Ruby]((https://www.ruby-lang.org/en/), [Jekyll](https://jekyllrb.com/), and the [Python `requests` package](https://pypi.org/project/requests/).
36+
This involves cloning the repository and installing its dependencies: [Git](https://git-scm.com/), [Ruby]((https://www.ruby-lang.org/en/), [Jekyll](https://jekyllrb.com/), and the [Python `requests` package](https://pypi.org/project/requests/).
3737

3838
1. Use [`git`](https://git-scm.com/) to [clone](https://git-scm.com/docs/git-clone) the public `plotly/graphing-library-docs` repository.
3939

@@ -53,9 +53,9 @@ Your branch is up to date with 'origin/master'.
5353
nothing to commit, working tree clean
5454
```
5555

56-
2. Download Ruby and check your `Ruby` version by running the `ruby --version` command in your terminal.
56+
2. Download Ruby and check your `Ruby` version by running the `ruby --version` command in your terminal.
5757

58-
**Note:** We recommend using `version 2.3.3` or the same ruby version as [gh-pages](https://pages.github.com/versions/). Note [RVM](https://rvm.io/rvm/install) is helpful for installing and managing ruby versions.
58+
**Note:** We recommend using `version 2.7.4`, the same ruby version as [gh-pages](https://pages.github.com/versions/). Note [RVM](https://rvm.io/rvm/install) is helpful for installing and managing ruby versions.
5959

6060
3. Download Jekyll and check your Jekyll version by running the `jekyll -v` command in your terminal. We recommend using the same ruby version as [gh-pages](https://pages.github.com/versions/).
6161

@@ -72,15 +72,15 @@ bundle install
7272

7373
6. Visit the pages at: [http://localhost:4000/](http://localhost:4000)
7474

75-
**Note** The default Jekyll configuration file only builds the JavaScript posts by [excluding folders](https://jekyllrb.com/docs/configuration/options/). If you want to override this behavior, serve the application with a custom Jekyll configuration file in the root of the repository. Do this by copying `_config_dev.yml`, renaming it `_config_personal.yml`, and modifying the `exclude` statement.
75+
**Note** The default Jekyll configuration file only builds the JavaScript posts by [excluding folders](https://jekyllrb.com/docs/configuration/options/). If you want to override this behavior, serve the application with a custom Jekyll configuration file in the root of the repository. Do this by copying `_config_dev.yml`, renaming it `_config_personal.yml`, and modifying the `exclude` statement.
7676

77-
- If you name the Jekyll configuration file `_config_personal.yml`, it will be caught by the `.gitignore` file and not committed to version control.
77+
- If you name the Jekyll configuration file `_config_personal.yml`, it will be caught by the `.gitignore` file and not committed to version control.
7878
- Run `bundle exec jekyll serve --config _config_personal.yml` to use the custom configuration file
7979

8080
- Example configuration:
8181
```yml
8282
# ---
83-
# Excludes every directory except JavaScript
83+
# Excludes every directory except JavaScript
8484
# ---
8585
exclude: ['_posts/reference_pages', _posts/ggplot2','_posts/julia','_posts/matlab','_posts/node_js','_posts/r','_posts/python','_posts/python-v3','_posts/misc','_posts/dashboards',_posts/scala', '_posts/nodejs', 'node_modules']
8686
```
@@ -91,26 +91,26 @@ Change it to this:
9191

9292
```yml
9393
# ---
94-
# Excludes no directory
94+
# Excludes no directory
9595
# ---
9696
staticurl: http://localhost:4000/all_static
9797
exclude: []
9898
```
9999

100-
and you'll load every file because no directories are excluded.
100+
and you'll load every file because no directories are excluded.
101101

102102
## Continuous Integration
103103

104104
Whenever a pull request is made, a continuous integration workflow is initiated. This includes of:
105105
- running the `check-or-enforce-order.py` and `front-matter-ci.py` scripts inside of a Docker container to validate YAML front-matter
106106
- Percy screenshot testing
107107

108-
Making sure that a pull request passes every continuous integration test is a part of the code review process.
108+
Making sure that a pull request passes every continuous integration test is a part of the code review process.
109109

110110
**For more information about the build process, inspect the CircleCI configuration file in this repository at https://github.com/plotly/graphing-library-docs/blob/master/.circleci/config.yml.**
111111

112112
## Other Documentation
113113

114114
This repository also contains:
115115
- Plotly's Node.js, Matlab, Scala, Julia, and Python V3 graphing libraries documentation
116-
- the reference pages for Plotly's JavaScript, Python, R, and Matlab graphing libraries.
116+
- the reference pages for Plotly's JavaScript, Python, R, and Matlab graphing libraries.

0 commit comments

Comments
 (0)