Pantheon Docs
Latest commit bc0ef7f Dec 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Fix CircleCI caching. Jul 25, 2018
.github Update ISSUE_TEMPLATE.md Jun 25, 2018
app fix external links Oct 24, 2018
features Restore stable deps in composer and clean up deployment script Dec 13, 2016
scripts fix path to terminus executable Oct 2, 2018
source fix cert paths Dec 14, 2018
.dockerignore Squashed commit, details below. Jul 5, 2018
.gitignore ignore vim swp files May 4, 2017
.mention-bot Disable mention-bot Jun 13, 2016
CONTRIBUTING.md Squashed work on Docker container and scripts Jul 5, 2018
Dockerfile specify legacy CI image, update terminus location Oct 1, 2018
Gemfile Squashed commit, details below. Jul 5, 2018
Gemfile.lock CVE-2017-18258 Jun 5, 2018
Gruntfile.js Remove Avenir, add MyFontsWebfontsKit Apr 2, 2018
LICENSE Changing "snippit" to "snippet" Apr 29, 2015
README.md Update docker badge version Aug 2, 2018
Rakefile Remove prod specifications, revert Rakefile and revise contributing.md Dec 14, 2015
VERSION version 0.1.4 Oct 1, 2018
Vagrantfile Hotfix provision script - composer self-update Aug 8, 2017
behat.yml adjust behat configuration: base and host urls Jan 11, 2016
budget.json Skipping yminify sitespeed test. To be added back in #1553 Apr 22, 2016
build.sh version 0.0.4 Jul 5, 2018
composer.json Squashed Commit, details below Jul 5, 2018
composer.lock Run composer update Jul 17, 2018
index.php Finalize home page, add featured tag Mar 17, 2016
package-lock.json Squashed Commit, details below Jul 5, 2018
package.json Squashed Commit, details below Jul 5, 2018
release.sh version 0.0.4 Jul 5, 2018
runthedocs.sh version 0.0.8 Jul 5, 2018
sculpin.json Revert "Replaced getpantheon.com with pantheon.io 45 times in 23 files" Jun 30, 2015
sculpin.lock global replacement to frontend Oct 2, 2017
style-guide.md arbitrary change Mar 27, 2018
updater.sh Squashed commit, details below. Jul 5, 2018
wraith.yaml Squashed commit, details below. Jul 5, 2018

README.md

Build Status: Circle CI

Docker Image Version:

Pantheon Documentation

https://pantheon.io/docs/

This repository contains the Pantheon documentation, as well as the tools to build local test environmnets.

Contributing

Our docs are written in PHP Markdown, and live in source/_docs. Read CONTRIBUTING.md for more details on contributing documentation improvements.

Style Guide

Read style-guide.md for our guidelines on how to write documentation.

Get the Code

Fork and clone this repository. Issue pull requests per document.

Local Setup (Optional)

If you would like to develop documentation locally and see your work, we offer a Docker containerized solution.

Prerequisites

  • MacOS or Linux system (untested on Bash on Windows)
  • Docker

Install

  1. Clone the repository to your project directory:

    cd ~/projects
    git clone https://github.com/pantheon-systems/documentation.git
    
    OR
    
    git clone git@github.com:pantheon-systems/documentation.git
  2. Pull the Docker image:

    docker image pull pantheonsystems/documentation

Run

  1. From the project root, execute the runthedocs.sh script:

    cd documentation
    ./runthedocs.sh

    Note:: This will occupy the terminal in which you invoke the script, providing output when files are changed or loaded. Use CTRL + C to exit.

    You should see:

    Creating the Docker container...
    Container built and running. 👍👍
    Building the latest docs...
    Detected new or updated files
    Generating: 100% (1035 sources / 0.06 seconds)
    Converting: 100% (1122 sources / 8.04 seconds)
    Formatting: 100% (1122 sources / 2.73 seconds)
    Processing completed in 12.20 seconds
    Running "watch" task
    Waiting...

    Once running, you can view the local dev environment by visiting http://localhost:8000/docs in your browser.

    The Docker image will mount the source directory from the project root on your computer, and rebuild when you save changes:

    /documentation/source/_docs/getting-support.md was changed. Building...
    Detected new or updated files
    Generating: 100% (1035 sources / 0.04 seconds)
    Converting: 100% (1122 sources / 5.73 seconds)
    Formatting: 100% (1122 sources / 2.01 seconds)
    Processing completed in 9.05 seconds
  2. When you're done, run:

    docker container stop pantheon-docs

Update The Docs

The pantheon-docs container mounts the documentation/source directory from your computer, so the image remains evergreen as long as the toolset is unchanged. To update your local project with the latest version of the docs, you need only pull them from git:

git pull origin

Update The App

  1. To update the documentation build locally run:

    ./updater.sh

Testing

We include several tools to test that new content doesn't break the documentation. Most of these tests are performed automatically by our continuous integration service, but pull requests created from external contributors aren't included in CI tests. If you want to manually test your branch, you can execute the following tests within the Docker container.

Merge Conflicts

To check for merge conflict messages accidentally commited into the docs, run the merge_conflicts.sh script:

docker exec pantheon-docs scripts/merge_conflicts.sh
Merge conflict:pass

HTMLProofer

To make sure all relative links (like /docs/support/) are correct, run

docker exec pantheon-docs htmlproofer --assume-extension  ./output_dev/ --disable-external true

A11y

We use grunt to manage accessibility tests:

docker exec pantheon-docs node_modules/.bin/grunt test
Running "a11y:dev" (a11y) task

Done, without errors.

Wraith

Checks for visual regression:

docker exec pantheon-docs wraith capture wraith.yaml

Behat

docker exec pantheon-docs bin/behat