Skip to content

Commit fee8423

Browse files
tarzzztarzzz
committed
Merge branch 'source-design-merge' of https://github.com/plotly/documentation into range-slider
2 parents 75a684e + e82af2c commit fee8423

26 files changed

+5966
-689
lines changed

‎Contributing.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## repo organization
2-
edit or add files in the `_posts` folder in the [source](http://github.com/plotly/documentation/tree/source) branch
2+
edit or add files in the `_posts` folder in the [source-design-merge](http://github.com/plotly/documentation/tree/source-design-merge) branch
33

44
## Converting IPython Notebooks to github pages
55

6-
Check out any of the notebooks in [https://github.com/plotly/documentation/tree/source/_posts/tutorials](https://github.com/plotly/documentation/tree/source/_posts/tutorials)
6+
Check out any of the notebooks in [https://github.com/plotly/documentation/tree/source-design-merge/_posts/tutorials](https://github.com/plotly/documentation/tree/source-design-merge/_posts/tutorials)
77

88
The last cell of these notebooks will convert the notebook into a github pages friendly html format:
99

@@ -12,16 +12,16 @@ The last cell of these notebooks will convert the notebook into a github pages f
1212
## Converting R Markdown to github pages
1313

1414
The full bleed R pages are created with R Markdown. Here's how:
15-
- Write your tutorial in R Markdown. Copy any of the `.Rmd` files in this folder: https://github.com/plotly/documentation/tree/source/_posts/r, e.g. https://github.com/plotly/documentation/blob/source/_posts/r/2015-07-30-3d-line-plots.Rmd
15+
- Write your tutorial in R Markdown. Copy any of the `.Rmd` files in this folder: https://github.com/plotly/documentation/tree/source-design-merge/_posts/r, e.g. https://github.com/plotly/documentation/blob/source-design-merge/_posts/r/2015-07-30-3d-line-plots.Rmd
1616
- Convert the R Markdown to Markdown: `knitr::knit("2015-08-03-your-r-markdown-tutorial.Rmd")`. Or, in the terminal: `Rscript -e 'knitr::knit("2015-08-03-your-r-markdown-tutorial.Rmd")'`
1717

1818
## Rendering the pages locally
1919
0. Clone the repo. `$ git clone git@github.com:plotly/documentation.git`
20-
1. Check out the source branch:
20+
1. Check out the source-design-merge branch:
2121

2222
```
2323
$ git fetch origin
24-
$ git checkout source
24+
$ git checkout source-design-merge
2525
```
2626
2. [Install jekyll](http://jekyllrb.com/docs/installation/). **Important** - Install Jekyll version 2.5.3:
2727

@@ -64,21 +64,21 @@ exclude: []
6464
and it'll load everything.
6565

6666
## Deploying changes
67-
Our repo has become too big for github to process. Edit files on the `source` branch instead of the `gh-pages` branch.
67+
Our repo has become too big for github to process. Edit files on the `source-design-merge` branch instead of the `gh-pages` branch.
6868

6969
To deploy, first install `_config.yml` package dependencies:
7070
```
71-
documentation (source) $ sudo gem install jekyll-redirect-from
72-
documentation (source) $ sudo gem install jekyll-sitemap
73-
documentation (source) $ sudo gem install terminal-notifier
74-
documentation (source) $ sudo gem install jemoji
75-
documentation (source) $ sudo gem install redcarpet
71+
documentation (source-design-merge) $ sudo gem install jekyll-redirect-from
72+
documentation (source-design-merge) $ sudo gem install jekyll-sitemap
73+
documentation (source-design-merge) $ sudo gem install terminal-notifier
74+
documentation (source-design-merge) $ sudo gem install jemoji
75+
documentation (source-design-merge) $ sudo gem install redcarpet
7676
7777
```
7878

7979
Then, deploy changes with:
8080
```
81-
documentation (source) $ rake deploy
81+
documentation (source-design-merge) $ rake deploy
8282
```
8383

84-
(from the `source` branch in the root of the `documentation` repo)
84+
(from the `source-design-merge` branch in the root of the `documentation` repo)

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plotly's github-pages api documentation repository
22

3-
- the [source](http://github.com/plotly/documentation/tree/source) branch is where edits and contributions are made
4-
- the [gh-pages](http://github.com/plotly/documentation/tree/gh-pages) branch is the deploy branch, automatically updated with `$ rake deploy` inside [source](http://github.com/plotly/documentation/tree/source)
3+
- the [source-design-merge](http://github.com/plotly/documentation/tree/source-design-merge) branch is where edits and contributions are made
4+
- the [gh-pages](http://github.com/plotly/documentation/tree/gh-pages) branch is the deploy branch, automatically updated with `$ rake deploy` inside [source-design-merge](http://github.com/plotly/documentation/tree/source-design-merge)
55

6-
interested in contributing? see [Contributing.md](https://github.com/plotly/documentation/blob/source/Contributing.md)
6+
interested in contributing? see [Contributing.md](https://github.com/plotly/documentation/blob/source-design-merge/Contributing.md)

‎_config_dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ plotlyjs_download_url: https://cdn.plot.ly/plotly-latest.min.js
1717
# Excludes
1818
# ---
1919
# all of the posts: ['*.Rmd','_posts/2015-09-09-matlab-reference.html','_posts/2015-09-06-r-reference.html','_posts/2015-09-06-python-reference.html','_posts/2015-08-19-plotly_js-reference.html','_posts/2015-04-05-ggplot2-index.html','_posts/2015-04-05-julia-index.html','_posts/2015-04-05-matlab-index.html','_posts/2015-04-05-matplotlib-index.html','_posts/2015-04-05-node_js-index.html','_posts/2015-04-05-plotly_js-index.html','_posts/2015-04-05-plotlyjs-function-reference.md','_posts/2015-04-05-python-index.html','_posts/2015-05-25-ipython-notebooks_gallery.html','_posts/2015-05-25-ipython-notebooks_index.html','_posts/2015-07-13-eula_index.html','_posts/2015-07-19-pandas.html','_posts/2015-07-26-index.html','_posts/2015-07-30-r-index.Rmd','_posts/2015-07-30-r-index.md','_posts/2015-08-20-research-box-index.html','_posts/ggplot2','_posts/julia','_posts/matlab','_posts/matplotlib','_posts/nodejs','_posts/pandas','_posts/plotly_js','_posts/python','_posts/r','_posts/tutorials','_posts/user_guide_matlab','_posts/user_guide_python']
20-
exclude: ['*.Rmd','_posts/2015-09-09-matlab-reference.html','_posts/2015-09-06-r-reference.html','_posts/2015-09-06-python-reference.html','_posts/2015-08-19-plotly_js-reference.html','_posts/2015-04-05-ggplot2-index.html','_posts/2015-04-05-julia-index.html','_posts/2015-04-05-matplotlib-index.html','_posts/2015-04-05-node_js-index.html','_posts/2015-04-05-plotlyjs-function-reference.md','_posts/2015-05-25-ipython-notebooks_gallery.html','_posts/2015-05-25-ipython-notebooks_index.html','_posts/2015-07-13-eula_index.html','_posts/2015-07-19-pandas.html','_posts/2015-07-26-index.html','_posts/2015-07-30-r-index.Rmd','_posts/2015-07-30-r-index.md','_posts/2015-08-20-research-box-index.html','_posts/ggplot2','_posts/julia','_posts/matplotlib','_posts/nodejs','_posts/pandas','_posts/r','_posts/tutorials','_posts/user_guide_python']
20+
exclude: ['*.Rmd','_posts/2015-09-09-matlab-reference.html','_posts/2015-09-06-r-reference.html','_posts/2015-09-06-python-reference.html','_posts/2015-08-19-plotly_js-reference.html','_posts/2015-04-05-ggplot2-index.html','_posts/2015-04-05-julia-index.html','_posts/2015-04-05-matlab-index.html','_posts/2015-04-05-matplotlib-index.html','_posts/2015-04-05-node_js-index.html','_posts/2015-04-05-plotlyjs-function-reference.md','_posts/2015-04-05-python-index.html','_posts/2015-05-25-ipython-notebooks_gallery.html','_posts/2015-05-25-ipython-notebooks_index.html','_posts/2015-07-13-eula_index.html','_posts/2015-07-19-pandas.html','_posts/2015-07-26-index.html','_posts/2015-07-30-r-index.Rmd','_posts/2015-07-30-r-index.md','_posts/2015-08-20-research-box-index.html','_posts/ggplot2','_posts/julia','_posts/matlab','_posts/matplotlib','_posts/nodejs','_posts/pandas','_posts/python','_posts/r','_posts/tutorials','_posts/user_guide_matlab','_posts/user_guide_python']
2121
#exclude: [_posts/temp, '*.Rmd']
2222

2323
# ---

‎_data/plotschema.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎_posts/ggplot2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Contribute to Plotly's [ggplot2 Documentation](https://plot.ly/ggplot2/)
22
## Initial Steps:
3-
0. Clone the repo and then check out the source branch:
3+
0. Clone the repo and then check out the source-design-merge branch:
44

55
```
66
$ git clone git@github.com:plotly/documentation.git
77
$ git fetch origin
8-
$ git checkout source
8+
$ git checkout source-design-merge
99
```
1010
1. [Install jekyll](http://jekyllrb.com/docs/installation/). <b>IMPORTANT</b> - [Install the same version that Github Pages is using: 3.0.3](https://pages.github.com/versions/):
1111

‎_posts/ggplot2/getting-started/2015-08-10-getting-started_ggplot2_index.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,31 @@ language: ggplot2
1313
# Plotly for R
1414

1515
Plotly is R package for creating interactive web-based graphs via [plotly](https://plot.ly/)'s JavaScript graphing library, `plotly.js`.
16-
The `plotly` R libary contains a function `ggplotly` which will convert `ggplot2` figures into graphs drawn with `plotly.js` and saved in your online plotly account.
16+
The `plotly` R libary contains a function `ggplotly` which will convert `ggplot2` figures into graphs drawn with `plotly.js` which can be saved to your online plotly account or rendered locally.
1717

1818
<a href="https://travis-ci.org/ropensci/plotly">
1919
<img alt="Build Status" style="margin: 0;" src="https://travis-ci.org/ropensci/plotly.png?branch=master">
2020
</a>
2121

2222
#### Installation
2323

24-
__plotly__ is not (yet) available on CRAN, but you can install it via [devtools](http://cran.r-project.org/web/packages/devtools/):
24+
__plotly__ is now available on CRAN.
25+
26+
```r
27+
install.packages("plotly")
28+
```
29+
30+
To install the **dev** version use:
2531

2632
```r
27-
install.packages("viridis") # dependency
2833
install.packages("devtools")
2934
devtools::install_github("ropensci/plotly")
3035
```
3136

32-
3337
#### Signup
3438

3539
If you don't already have a plotly account, either [signup online](https://plot.ly/ssu/) or use the `signup()` function (see the `help(signup)` page for more details).
3640

37-
Note you can check if you have a username and API key with:
38-
39-
```r
40-
plotly:::verify("username")
41-
plotly:::verify("api_key")
42-
```
43-
4441
#### Credentials
4542

4643
Find your credentials [in our online settings](https://plot.ly/settings/api). Set them in your R session with:
@@ -79,7 +76,7 @@ p <- ggplot(data = d, aes(x = carat, y = price)) +
7976
geom_point(aes(text = paste("Clarity:", clarity)), size = 4) +
8077
geom_smooth(aes(colour = cut, fill = cut)) + facet_wrap(~ cut)
8178

82-
(gg <- ggplotly(p))
79+
ggplotly(p)
8380
```
8481

8582
<iframe height="600" id="igraph" scrolling="no" seamless="seamless" src="https://plot.ly/~RPlotBot/1284.embed" width="800" frameBorder="0"></iframe>
@@ -88,3 +85,9 @@ p <- ggplot(data = d, aes(x = carat, y = price)) +
8885
<a href="/r/" class="button no_underline">View more examples</a>
8986
</div>
9087

88+
#### Publishing graphs to your online plotly account
89+
You can publish your newly created plotly graph to your online plotly account by using `plotly_POST()`.
90+
91+
```r
92+
plotly_POST(p, "Sample Plotly Chart")
93+
```

0 commit comments

Comments
 (0)