Polymer/docs

Name: docs

Owner: polymer

Description: Documentation for Polymer

Created: 2013-01-24 19:11:00.0

Updated: 2018-01-07 17:58:52.0

Pushed: 2018-01-18 22:47:37.0

Homepage: https://www.polymer-project.org

Size: 116067

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Polymer documentation site

https://www.polymer-project.org/

Install

The documentation site runs in Google App Engine, using the App Engine Python standard environment. Before you start you'll need the following prerequisites:

• Python 2.7

• Google Cloud SDK

• App Engine Python standard environment. Ensure this is installed by running the following command:

  gcloud components install app-engine-python
  

  Or, if you installed via apt:

  sudo apt-get install google-cloud-sdk-app-engine-python
  

Set up your repo:

git clone https://github.com/Polymer/docs --recursive
cd docs
npm install

Note: --recursive will init and checkout submodules as well.

If you have cloned and built an earlier version of the doc site (before June 2016), note that the site has changed and the master branch shares no history with the old master branch. The easiest way to get up and running with the new site is to create a brand new repo as described above, to avoid introducing any artifacts from the old doc site.

You can find the old doc site (including Polymer 0.5 docs) in the docs-05 branch.

Running the site

The first time you run the site, run gulp to build the site in its entirety:

gulp

Then start the App Engine dev server on dist/app.yaml:

dev_appserver.py dist/

The site will be served from http://localhost:8080.

Making changes / watching files / live reload

If you're making changes use the watch task. Optionally add --reload to live reload the tab when changes are saved.

gulp watch --reload

The site will be served on http://localhost:3000. Making changes will refresh the browser tab.

Optional flags:

• --reload: refreshes the browser tab when changes are made
• --open: opens a new browser tab when gulp watch is started

Tip - run gulp help to see the list of available gulp tasks.

Run tests

Install WebTest framework:

pip install WebTest

Then run:

npm test

If your Google Cloud SDK isn't installed in ~/google-cloud-sdk, set the CLOUD_SDK environment variable to the path to the Cloud SDK:

export CLOUD_SDK=~/cloud/google-cloud-sdk

Deployment

Build and deploy version YYY-MM-DD of the site:

gulp
npm run deploy YYYY-MM-DD