initial repo setup

Author: Joseph Damiba

.circleci/config.yml

@@ -0,0 +1,120 @@
+version: 2
+jobs:
+  build:
+    branches:
+      ignore:
+        - gh-pages
+
+    docker:
+      # a packaged system that has the instructions for creating a running container.
+      - image: circleci/ruby:2.3.3
+
+    # actions that need to be taken to perform your job
+    steps:
+      - add_ssh_keys:
+          fingerprints:
+            - "dc:5f:39:48:00:b4:72:34:e1:d2:c4:e1:1f:d1:e2:ce" #plotlydocbot
+
+      - restore_cache:
+          keys:
+            - source-v1- #one time, not every time!
+
+      # checks out the source code for a job over SSH
+      - checkout
+
+      - save_cache:
+          key: source-v1-1 # Sept 7, 2019
+          paths:
+            - ".git"
+
+      - restore_cache:
+          keys:
+            - gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+            - gem-cache-v1-{{ arch }}-{{ .Branch }}
+            - gem-cache-v1
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --path vendor/bundle
+            sudo apt-get update
+            sudo apt install python-pip
+            sudo pip install python-frontmatter
+            sudo pip install pathlib
+
+      - save_cache:
+          key: gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: deployment
+          command: |
+            git config --global user.email "accounts@plot.ly"
+            git config --global user.name "plotlydocbot"
+            echo 
+            echo "token: ${mapbox_token}" > _data/mapbox_token.yml
+            rm -rf _posts/python/html
+            rm -rf _posts/r/md
+            git clone -b built git@github.com:plotly/plotly.py-docs _posts/python/html
+            git clone -b built git@github.com:plotly/plotly.r-docs _posts/r/md
+            mv _posts/r/md/ggplot2 _posts/ggplot2/md
+            python front-matter-ci.py _posts
+            python check-or-enforce-order.py _posts/python
+            python check-or-enforce-order.py _posts/python-v3
+            python check-or-enforce-order.py _posts/r/
+            python check-or-enforce-order.py _posts/plotly_js
+            bundle exec jekyll build
+            rm _data/mapbox_token.yml
+            mkdir snapshots
+            cd _site
+            cp -r 'all_static' '../snapshots'
+            cp 'api/index.html' '../snapshots'
+            cp --parents 'python/index.html' '../snapshots'
+            cp --parents 'python/getting-started/index.html' '../snapshots'
+            cp --parents 'python/plotly-fundamentals/index.html' '../snapshots'
+            cp --parents 'python/line-and-scatter/index.html' '../snapshots'
+            cp --parents 'r/index.html' '../snapshots'
+            cp --parents 'r/getting-started/index.html' '../snapshots'
+            cp --parents 'r/plotly-fundamentals/index.html' '../snapshots'
+            cp --parents 'r/line-and-scatter/index.html' '../snapshots'
+            cp --parents 'javascript/index.html' '../snapshots'
+            cp --parents 'javascript/plotly-fundamentals/index.html' '../snapshots'
+            cp --parents 'javascript/getting-started/index.html' '../snapshots'
+            cp --parents 'javascript/line-and-scatter/index.html' '../snapshots'
+            cp --parents 'ggplot2/index.html' '../snapshots'
+            cp --parents 'ggplot2/getting-started/index.html' '../snapshots'
+            cp --parents 'ggplot2/geom_abline/index.html' '../snapshots'
+            cp --parents 'python/v3/index.html' '../snapshots'
+            cp --parents 'python/v3/plotly-fundamentals/index.html' '../snapshots'
+            cp --parents 'python/v3/getting-started/index.html' '../snapshots'
+            cp --parents 'python/v3/line-and-scatter/index.html' '../snapshots'
+            cp --parents 'matlab/index.html' '../snapshots'
+            cp --parents 'matlab/getting-started/index.html' '../snapshots'
+            cp --parents 'matlab/graphing-multiple-chart-types/index.html' '../snapshots'
+            cp --parents 'matlab/scatter/index.html' '../snapshots'
+            cd ..
+            rm -f 'snapshots/all_static/javascripts/jquery-knob/index.html'
+            rm -f 'snapshots/all_static/images/Plotly-feed2.html'
+            rm -f 'snapshots/all_static/images/Plotly.html'
+            rm -f 'snapshots/all_static/images/Plotly-Feed.html'
+            sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*.html
+            sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*/*.html
+            sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*/*/*.html
+            rm -f snapshots/*.bkp
+            rm -f snapshots/*/*.bkp
+            rm -f snapshots/*/*/*.bkp
+            percy snapshot snapshots --enable_javascript
+            rm -rf 'snapshots/'
+            if [ "${CIRCLE_BRANCH}" == "test-gld-ci-setup" ]; then
+              git clone --depth=1 --branch=test-gld-ci-setup https://github.com/plotly/documentation.git
+              git config user.name plotlydocbot
+              git config user.email accounts@plot.ly
+              cp -r _site/* documentation
+              cd documentation
+              git add .
+              git commit -m "deploying https://github.com/plotly/graphing-libraries-docs/commit/${CIRCLE_SHA1}"
+              git push
+              cd ..
+              rm -rf documentation
+            fi

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: https://plot.ly/products/consulting-and-oem/

.gitignore

@@ -0,0 +1,32 @@
+*.ipynb_checkpoints
+*.pyc
+*.idea
+*.DS_Store
+.*.swp
+users.json
+port.sh
+*~
+_site
+_posts/user_guide_python/streaming-template.ipynb
+
+node_modules
+
+.RData
+.Rhistory
+.sass-cache
+.DS_Store
+.jekyll-metadata
+.mapbox_token
+
+vendor/bundle
+.bundle
+_posts/python/fundamentals/static-image/images
+_config_personal.yml
+_posts/python/html
+.Rproj.user
+documentation.Rproj
+.vscode
+_posts/r/md
+_posts/ggplot2/md
+
+_data/mapbox_token.yml

404.html

@@ -0,0 +1,96 @@
+---
+name: 404
+language: Page Not Found
+---
+
+<!DOCTYPE html>
+<html>
+        {% include layouts/head.html %}
+
+
+<body data-spy="scroll" data-target=".watch" style="position:relative;">
+{% include layouts/google-tag-body.html %}
+
+<!--[if lt IE 10]>
+<p class="browserupgrade">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade
+    your browser</a> to improve your experience.</p>
+<![endif]-->
+
+{% include layouts/lang-splash-banner.html %}
+
+{% include layouts/_header-main.html %}
+
+<main class="--page page--single --index not-found">
+
+    <div class="--wrap">
+        <!-- aside - Main Sidebar-->
+        <!-- Main-->
+        <section class="--page-body --full-width">
+
+            <section class="content">
+
+                <div class="page404">
+                    <div class="page404-heading">
+                        4<div class="page404-bars">
+                        <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px"     y="0px" width="40px" height="40px" viewBox="0 0 304.128 246.216" enable-background="new 0 0 304.128 246.216"
+                      xml:space="preserve">
+                          <g>
+                           <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M125.3,123.066c0,40.407-0.008,80.813,0.031,121.219
+                                c0.001,1.588-0.347,1.932-1.57,1.926c-10.917-0.061-21.834-0.032-32.751-0.039c-1.731-0.001-1.558,0.249-1.558-1.894
+                                c-0.003-80.813,0-161.625-0.026-242.438c0-1.378,0.196-1.848,1.408-1.841c11.037,0.065,22.074,0.058,33.111,0.009
+                                c1.067-0.005,1.384,0.29,1.383,1.688C125.293,42.154,125.3,82.61,125.3,123.066z"/>
+                          <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M214.786,140.75c0,34.522-0.008,69.046,0.027,103.568
+                                c0.001,1.483-0.252,1.905-1.491,1.898c-11.078-0.068-22.156-0.065-33.234-0.001c-1.169,0.006-1.25-0.556-1.25-1.735
+                                c0.019-69.244,0.02-138.49-0.007-207.734c0-1.291,0.222-1.676,1.307-1.67c11.118,0.055,22.236,0.055,33.354,0.001
+                                c1.067-0.005,1.319,0.343,1.317,1.656C214.779,71.405,214.786,106.078,214.786,140.75z"/>
+                          <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M134.18,158.268c0-28.739,0.007-57.477-0.022-86.215
+                                c-0.001-1.324,0.222-1.744,1.353-1.738c11.079,0.058,22.158,0.052,33.237,0.006c1.006-0.004,1.25,0.337,1.25,1.574
+                                c-0.025,57.576-0.025,115.151-0.001,172.728c0.001,1.222-0.225,1.588-1.241,1.582c-11.119-0.047-22.238-0.046-33.357,0
+                                c-1.009,0.006-1.241-0.345-1.24-1.573C134.187,215.844,134.18,187.056,134.18,158.268z"/>
+                          <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M223.665,193.287c0-16.962,0.013-33.925-0.024-50.887
+                                c-0.003-1.355,0.265-1.732,1.372-1.726c11.079,0.054,22.157,0.051,33.235,0.001c1.022-0.003,1.234,0.365,1.233,1.583
+                                c-0.026,34.125-0.026,68.25,0.001,102.375c0.001,1.229-0.23,1.579-1.24,1.573c-11.118-0.046-22.236-0.046-33.355,0
+                                c-1.014,0.006-1.246-0.354-1.244-1.58C223.675,227.511,223.665,210.4,223.665,193.287z"/>
+                          <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M44.694,211.117c0-11.222,0.018-22.443-0.024-33.663
+                                c-0.004-1.296,0.228-1.672,1.31-1.667c11.114,0.054,22.229,0.048,33.343,0.005c1.004-0.003,1.27,0.352,1.269,1.588
+                                c-0.028,22.442-0.028,44.885-0.001,67.327c0.001,1.176-0.252,1.501-1.2,1.496c-11.194-0.041-22.389-0.04-33.583-0.001
+                                c-0.906,0.003-1.136-0.31-1.133-1.424C44.707,233.558,44.694,222.337,44.694,211.117z"/>
+                          <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M286.165,246.176c-5.557,0-11.113-0.032-16.67,0.028
+                                c-0.965,0.012-1.179-0.348-1.175-1.5c0.034-10.721,0.033-21.441,0.001-32.163c-0.003-1.128,0.183-1.516,1.165-1.511
+                                c11.152,0.047,22.306,0.046,33.459,0.001c0.964-0.003,1.179,0.347,1.176,1.499c-0.035,10.721-0.042,21.442,0.007,32.162
+                                c0.006,1.332-0.357,1.518-1.294,1.509C297.277,246.151,291.721,246.176,286.165,246.176z"/>
+                          <path fill-rule="evenodd" clip-rule="evenodd" fill="#FFF"
+                              d="M17.89,246.176c-5.599,0-11.197-0.019-16.796,0.021
+                                c-0.801,0.006-1.097-0.201-1.094-1.295c0.033-10.874,0.03-21.749,0.002-32.623c-0.002-1.002,0.248-1.24,1.016-1.238
+                                c11.237,0.028,22.475,0.035,33.711-0.009c0.943-0.003,1.105,0.387,1.103,1.452c-0.029,10.774-0.033,21.55,0.004,32.324
+                                c0.004,1.154-0.28,1.4-1.151,1.393C29.087,246.153,23.488,246.176,17.89,246.176z"/>
+                        </g>
+                       </svg>
+                    </div>4
+                    </div>
+
+
+                    <div class="page404-txt">
+                        <h3>Plot twist!</h3>
+                        <br />
+                        <h5>There's nothing here...</h5><br />
+                        <h5> <a href="https://plot.ly/graphing-libraries">Back to Graphing Libraries documentation</a></h5>
+                    </div>
+                </div>
+
+            </section>
+        </section>
+    </div>
+</main>
+{% include layouts/helpbox.html %}
+
+{% include layouts/_footer-main.html %}
+</body>
+
+</html>

Contributing.md

@@ -0,0 +1,119 @@
+# Contributing to Plotly's Graphing Libraries Documentation
+
+## Repo Overview
+
+Plotly welcomes contributions to its [open-source graphing libraries documentation](https://plot.ly/graphing-libraries) from its community of users.
+
+This repository mainly serves:
+- Plotly's graphing libraries documentation index page at https://plot.ly/graphing-libraries. 
+
+- Plotly's JavaScript graphing library documentation at https://plot.ly/javascript
+    - Please be aware that **only the content of Plotly's JavaScript graphing library documentation** (hosted at https://plot.ly/javascript) is contained in this repository. You can find the content in the `_posts/plotly_js` directory. 
+    - For information about editing **plotly.js** documentation [click here](https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md).
+
+- Plotly's Python graphing library documentation at https://plot.ly/python
+    - The content for Plotly's Python graphing library documentation (hosted at https://plot.ly/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. 
+    - For information about editing **plotly.py** documentation [click here](https://github.com/plotly/plotly.py/blob/master/doc/README.md).
+
+- Plotly's R graphing library documentation at https://plot.ly/r
+    - The content for Plotly's R graphing library documentation (hosted at https://plot.ly/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.  
+    - For information about editing Plotly's **R** documentation [click here](https://github.com/plotly/plotly.r-docs/blob/master/README.md).
+
+## Contribute Quickly to Plotly's JavaScript Graphing Library Documentation
+  
+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.
+
+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:
+
+![Screen Shot 2020-01-07 at 12 45 39 PM](https://user-images.githubusercontent.com/1557650/71916356-bfe53800-314b-11ea-92b6-eb763037f6d5.png)
+
+**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. 
+
+## How To Get The Application Working Locally
+
+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. 
+
+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/). 
+
+1. Use [`git`](https://git-scm.com/) to [clone](https://git-scm.com/docs/git-clone) the public `plotly/documentation` repository. Then [check out] (https://git-scm.com/docs/git-checkout) the source-design-merge branch of the `git` repository.
+
+To do so, run the following commands in your terminal:
+
+```sh
+git clone git@github.com:plotly/documentation.git
+git fetch origin
+git checkout source-design-merge
+```
+
+**Note:** For historical reasons, the `source-design-merge` branch is the `master` branch of this repository. 
+
+Running `git status` in your terminal should then output the following:
+
+```sh
+On branch source-design-merge
+Your branch is up to date with 'origin/source-design-merge'.
+
+nothing to commit, working tree clean
+```
+
+2. Download Ruby and check your `Ruby` version by running the `ruby --version` command in your terminal. 
+
+**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.
+
+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/).
+
+4. Install bundler and dependencies from the Jekyll applicaton's [`Gemfile`](https://github.com/plotly/documentation/blob/source-design-merge/Gemfile) by running the following commands in your terminal:
+
+```sh
+gem install bundler
+bundle install
+```
+
+**Note:** These dependencies should be the same version that [gh-pages](https://pages.github.com/versions/) is using.
+
+5. Serve the Jekyll application: `bundle exec jekyll serve --config _config_dev.yml`.
+
+6. Visit the pages at: [http://localhost:4000/](http://localhost:4000)
+
+**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. 
+
+- If you name the Jekyll configuration file `_config_personal.yml`, it will be caught by the `.gitignore` file and not committed to version control. 
+- Run `bundle exec jekyll serve --config _config_personal.yml` to use the custom configuration file
+
+- Example configuration:
+```yml
+# ---
+# Excludes every directory except JavaScript 
+# ---
+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']
+```
+
+and you'll only load the files in `_posts/plotly_js` directory because that is the only directory that is not excluded.
+
+Change it to this:
+
+```yml
+# ---
+# Excludes no directory 
+# ---
+staticurl: http://localhost:4000/all_static
+exclude: []
+```
+
+and you'll load every file because no directories are excluded. 
+
+## Continuous Integration
+
+Whenever a pull request is made, a continuous integration workflow is initiated. This includes of:
+    - running the `check-or-enforce-order.py` and `front-matter-ci.py` scripts inside of a Docker container to validate YAML front-matter
+    - Percy screenshot testing
+
+Making sure that a pull request passes every continuous integration test is a part of the code review process. 
+
+**For more information about the build process, inspect the CircleCI configuration file in this repository at https://github.com/plotly/documentation/blob/source-design-merge/.circleci/config.yml.**
+
+## Other Documentation
+
+This repository also contains:
+    - Plotly's Node.js, Matlab, Scala, Julia, and Python V3 graphing libraries documentation
+    - the reference pages for Plotly's JavaScript, Python, R, and Matlab graphing libraries. 

Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+gem 'github-pages'
+gem 'jekyll-redirect-from'
+gem 'jemoji'
+gem 'octopress'
+gem 'rake'
+gem 'jekyll-sitemap'
+gem 'percy-cli'
+
+group :jekyll_plugins do
+  gem 'octopress-debugger'
+end
+
+group :jekyll_plugins do
+  gem 'algoliasearch-jekyll', '~> 0.8.2'
+end