You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17
Original file line number
Diff line number
Diff line change
@@ -5,35 +5,35 @@
5
5
Plotly welcomes contributions to its [open-source graphing libraries documentation](https://plotly.com/graphing-libraries) from its community of users.
6
6
7
7
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.
9
9
10
10
- 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.
12
12
- For information about editing **plotly.js** documentation [click here](https://github.com/plotly/graphing-library-docs/blob/master/_posts/plotly_js/README.md).
13
13
14
14
- 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.
16
16
- For information about editing **plotly.py** documentation [click here](https://github.com/plotly/plotly.py/blob/master/doc/README.md).
17
17
18
18
- 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.
20
20
- For information about editing Plotly's **R** documentation [click here](https://github.com/plotly/plotly.r-docs/blob/master/README.md).
21
21
22
22
## Contribute Quickly to Plotly's JavaScript Graphing Library Documentation
23
-
23
+
24
24
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.
25
25
26
26
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:
27
27
28
28

29
29
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.
31
31
32
32
## How To Get The Application Working Locally
33
33
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.
35
35
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/).
37
37
38
38
1. Use [`git`](https://git-scm.com/) to [clone](https://git-scm.com/docs/git-clone) the public `plotly/graphing-library-docs` repository.
39
39
@@ -53,9 +53,9 @@ Your branch is up to date with 'origin/master'.
53
53
nothing to commit, working tree clean
54
54
```
55
55
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.
57
57
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.
59
59
60
60
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/).
61
61
@@ -72,15 +72,15 @@ bundle install
72
72
73
73
6. Visit the pages at: [http://localhost:4000/](http://localhost:4000)
74
74
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.
76
76
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.
78
78
- Run `bundle exec jekyll serve --config _config_personal.yml` to use the custom configuration file
and you'll load every file because no directories are excluded.
100
+
and you'll load every file because no directories are excluded.
101
101
102
102
## Continuous Integration
103
103
104
104
Whenever a pull request is made, a continuous integration workflow is initiated. This includes of:
105
105
- running the `check-or-enforce-order.py` and `front-matter-ci.py` scripts inside of a Docker container to validate YAML front-matter
106
106
- Percy screenshot testing
107
107
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.
109
109
110
110
**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.**
0 commit comments