Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0c0e33f

Browse files
committed
rm deployment section
1 parent 59a9c0b commit 0c0e33f

File tree

1 file changed

+7
-21
lines changed

1 file changed

+7
-21
lines changed

Contributing.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
## Repo Organization
22
Edit or add files in the `_posts` folder in the [source-design-merge](http://github.com/plotly/documentation/tree/source-design-merge) branch.
33

4-
## Clone the Repo and Install Dependencies
4+
## Clone the Repo and Install Dependencies
55
1. Clone the repo and then check out the source-design-merge branch:
66

77
```
88
$ git clone [email protected]:plotly/documentation.git
99
$ git fetch origin
1010
$ git checkout source-design-merge
1111
```
12-
12+
1313
2. Check Ruby version `$ ruby --version`. We recommend using 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.
1414

1515
3. Install bundler and dependencies from the `gemfile`:
@@ -23,7 +23,7 @@ Note these dependencies should be the same version that gh-pages is using: https
2323
4. When we deploy, a function is run to update the plot schema. To do this successfully you have to make sure you have the `requests` python package: `pip install requests`
2424

2525
## Making Changes
26-
- For information about editing **plotly.js** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md
26+
- For information about editing **plotly.js** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md
2727
- For information about editing **python** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/python/README.md
2828
- For information about editing **R** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/r/README.md
2929
- For information about editing chart studio documentation found at [https://help.plot.ly/tutorials/](https://help.plot.ly/tutorials/) please see this repo: [https://github.com/plotly/plotly.github.io](https://github.com/plotly/plotly.github.io)
@@ -57,7 +57,7 @@ exclude: []
5757
and it'll load everything.
5858

5959
## Make a PR
60-
Ready for your changes to be reviewed? Make a pull request against the `source-design-merge` branch!
60+
Ready for your changes to be reviewed? Make a pull request against the `source-design-merge` branch!
6161
Create a feature branch and use `git status` to list changed files.
6262
```
6363
git checkout -b your_feature_branch
@@ -70,27 +70,13 @@ git add file-b
7070
git commit -m 'message about your changes'
7171
git push origin your_feature_branch
7272
```
73-
Visit the [documentation repo](https://github.com/plotly/documentation) and open a pull request against the `source-design-merge` branch. You can then tag @cldougl and @bcdunbar for a review.
74-
75-
## Deploying Changes
76-
After your PR has been approved and you have merged it into the `source-design-merge` branch you can deploy your changes! Our repo has become too big for github to process. Edit files on the `source-design-merge` branch instead of the `gh-pages` branch.
77-
78-
First checkout the `source-design-merge` branch (if you were still on your feature branch) and pull (you should see the changes from your latest merged pr):
79-
```
80-
git checkout source-design-merge
81-
git pull origin source-design-merge
82-
```
83-
84-
Deploy changes with:
85-
```
86-
documentation (source-design-merge) $ bundle exec rake deploy
87-
```
73+
Visit the [documentation repo](https://github.com/plotly/documentation) and open a pull request against the `source-design-merge` branch. You can then tag **@cldougl** and **@bcdunbar** for a review.
8874

89-
(from the `source-design-merge` branch in the root of the `documentation` repo)
75+
After your PR has been reviewed and approved, you can merge it into the `source-design-merge` branch! Your changes haven't been deployed yet so they won't be online. That said, be sure to check them after they have been deployed by either **@cldougl** or **@bcdunbar**.
9076

9177
## Search
9278

93-
We now have search via algolia implemented on our index and reference documentation pages! Please refer to our [make README](https://github.com/plotly/documentation/blob/source-design-merge/make_instructions.txt) for more information on how search works and instructions on how to update or edit Plotly search indices.
79+
We now have search via algolia implemented on our index and reference documentation pages! Please refer to our [make README](https://github.com/plotly/documentation/blob/source-design-merge/make_instructions.txt) for more information on how search works and instructions on how to update or edit Plotly search indices.
9480

9581
## Style Edits
9682

0 commit comments

Comments
 (0)