README.md

Pantheon Documentation

https://docs.pantheon.io/

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

Changelog

• 2023/02: Pantheon Docs is now a Pantheon Front-End site running Gatsby 4.
• 2019/08: We've relaunched the project using Gatsby for faster development, and much faster page speed.

Contributing

Our docs are written in Markdown and extended with MDX components. The pages live in source/content. Read CONTRIBUTING for more details on contributing documentation improvements.

Style Guide

Read our Style Guide for our guidelines on how to write documentation.

Local Installation

Prerequisites

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

• Node.js

• NVM

• Gatsby CLI:

  npm install -g gatsby-cli

• Alternatively, you can use Lando. Use Lando to bypass installing Node.js and the Gatsby CLI on your local machine. Lando requires a Docker version in the 2.1.0.0 - 3.1.99 range.

Mac Steps

This list of steps should work on a Mac with Homebrew:

brew install node
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
nvm install 18
npm install -g gatsby-cli

Using Git Hooks

Git hooks have been added to [.github/hooks](.github/hooks) to help automate some of the tasks that make it easier to work locally with the repository. The following hooks are available:

• pre-commit: Runs Prettier to check for code styling issues on updated/changed javascript files. If Prettier made any changes, those changes are automatically committed back to the PR. This mirrors the functionality of the Prettier GitHub Action.

To use the git hooks, you must configure your local environment to use .github/hooks as the hooks path (normally .git/hooks, but this folder is ignored by Git). This can be done by running the following command from the root of the repository:

git config core.hooksPath .github/hooks

It's recommended (but not required) to use the provided git hooks if you are working with any javascript files in the repository. This will help ensure that your changes are formatted correctly before being committed and ensure that your local environment and the remote branch are the same.

Get the Code

Fork and clone this repository:

git clone [email protected]:pantheon-systems/documentation.git
cd documentation

Using GitHub Codespaces

A GitHub Codespace can be used to test the site as well. To set up a Codespace, navigate to the branch you want to use as the base (e.g. main) and click the Code dropdown.

This will take you to a VSCode-like interface with a Terminal window.

Now you can run npm ci and npm start in the Terminal panel at the bottom of the page. The docs site will build inside the Codespaces container and install Node dependencies just like it would on your local machine. When the Node server is running, a dialog box will appear at the bottom right corner asking if you want to open the Codespace in a browser and if you want to make the Codespace public.

Clicking on the link will take you to a live site that's running on the current branch of the repository. If you opted to make the Codespace public, you can share the link to others and they will be able to view the site after accepting a warning that they are visiting someone else's Codespace. If the Codespace was not made public, only your GitHub user will be able to see it.

Working with branches on Codespaces

You can open a Codespace (or load an existing Codespace) on a particular branch by first navigating to that branch in the GitHub repository. Alternately, if you already have the VSCode editor open, you can select a specific branch by clicking the branch name at the bottom left, then selecting the branch you would like to switch to in the panel that appears at the top of the screen. The Codespace will make the necessary adjustments and rebuild the docs site on that branch.

Notes on running in Codespaces

Codespaces is free for individuals for 60 hours of runtime for 2 cores, after which your user is billed for additional time. It's unclear whether Pantheon's Enterprise account would own billing, but as of this writing it appears to be billed on a per user basis. For this reason, it's important to not leave your Codespaces running when you're done with them.

Install With The Gatsby Cli

From the documentation directory:

npm ci

Run

Still in the documentation directory:

npm start

Use your local browser to navigate to localhost:8000/.

Locally saved updates to docs are automatically refreshed in the browser.

Install With Lando

Alternatively, you can use Lando. The lando start command initiates the app, installs node dependencies, and starts the gatsby develop server for you:

lando start

You can view the local environment at localhost:8000/. Updates to docs are automatically refreshed in the browser.

Code Formatting

We use Prettier to enforce code style on changed files. On each pull request to the repository, if any .js, .jsx, .ts or .tsx files are modified in the /src directory, We run Prettier to check for code styling issues on the updated/changed files. If Prettier made any changes, those changes are automatically committed back to the PR (see example PR).

To automatically fix formatting issues across the entire /src directory, run:

npm run format

Be cautious when running this command, as it will automatically fix any formatting issues it can.

Testing

To reduced the likelihood of regressions and bugs this site uses a few different testing tools:

Visual Regression Tests

Within the tests directory there are a number of visual regression tests that can be run to compare the current state of the site to a PR preview or the live site. These tests are meant to be run locally instead of CI as they have a high rate of false positives.

Unit Tests

Unit tests for custom logic are written in in Vitest and can be executed with

npx vitest src/components

These tests are executed in CI via a GitHub Action.