Pantheon Documentation

Documentation Site

Visit https://pantheon.io/docs/ for the latest release of Pantheon documentation, which is:

• Version-controlled
• Forkable
• Continuously updated
• Written in markdown
• Generated by Sculpin

Contributing

Read CONTRIBUTING.md for more details on contributing documentation improvements.

Style Guide

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

Usage

Get the code:

Fork and clone this repository. Issue pull requests one document at a time.

Local Setup: Mac OS X and Linux (Optional)

Option 1: Vagrant (Recommended)

1. Install requirements:

• virtualBox >= 4.3.x
• ansible >= 1.8.x
• vagrant-hostmanager
• vagrant-auto_network

2. From inside the project root, run vagrant up
3. You will be prompted for the administration password on your host machine. Obey.
4. Visit http://docs.local:8000/docs in your browser of choice.
5. Automatically regenerate Sculpin and re-compile CSS upon file modifications:

vagrant ssh -- -t 'cd /vagrant; fuser -k -n tcp 8000;grunt watch & ./bin/sculpin generate --server --watch'

Option 2: Composer

1. Install composer: If you do not want to install Composer globally, please refer to getcomposer.org instructions.

Run the following command to install Composer globally:

curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

Note: Run the mv command with sudo if it fails.

2. Install dependencies:
   From within the root directory of this repository, run the following command to install all needed dependencies:

composer install

3. Start your local server:
   If you do not want to install Sculpin globally, use the following commands to start your local server:

./bin/sculpin generate --server

Visit your docs site at: http://localhost:8000/docs

In order to globally execute Sculpin, run the following commands:

curl -O https://download.sculpin.io/sculpin.phar
sudo chmod +x sculpin.phar
mv sculpin.phar /usr/local/bin/sculpin

Build Sculpin and run a local instance:

sculpin generate --server

Visit your docs site at: http://localhost:8000/docs

4. Images:

For images to render on your local environment you need to apply these commands from within the documentation directory:

$ cd output_dev
$ ln -s ./ source

5. Automatically regenerate Sculpin and re-compile CSS upon file modifications:

Install grunt and run the following from the root directory of this repository:

grunt watch & ./bin/sculpin generate --server --watch

Local Setup: Git for Windows (Optional)

Option 1: Vagrant (Recommended)

Follow the above steps to run the docs site on a virtual machine.

Option 2: Composer

1. If you do not already have PHP installed, use Windows Web Platform Installer or install manually.

Note: Be sure to add the folder containing php.exe to your PATH environment variable and reopen any command prompt shells.

2. Install Git for Windows.
3. Clone the documentation repository.
4. Download Sculpin.
5. Download Composer.
6. On the command prompt navigate to the documentation repository.
7. Install project dependencies:

php C:\your-path-to-composer\composer.phar install

8. Build Sculpin and run a local instance:

php C:\your-path-to-sculpin\sculpin.phar generate --server

Visit the local docs site at: http://localhost:8000/docs

Finally, you can tell Sculpin to watch the docs directory and automatically regenerate upon file modification:

php C:\your-path-to-sculpin\sculpin.phar generate --server --watch

If changes cause Sculpin to continuously regenerate files, drop --watch until you investigate and debug.

9. On the command prompt, create the following link for images to render on your local environment. Note: You may have to run the command shell as an administrator.

cd output_dev
mklink /d source .

Note: Run command prompt as administrator if you encounter permission errors.