Clone your docs repo
git clone git@github.com:org/repo
Clone this repo
git clone git@github.com:adobe/parliament-client-template.git
cd parliament-client-template
Install dependencies
yarn install
Create an environment File
Create a .env.development
and .env.production
files and define environment variables as below. Refer: https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
For local:
GATSBY_SITE_PATH_PREFIX = Demo
# Personal access token with read access created from github as per instructions [here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
GATSBY_GIT_CORP_TOKEN = 1cdba7077XXXXXXXXXXXXXXXX633c1
# Repo URL in given format which you want to use to generate a microsite
# NOTE: for Enterprise instances, this MUST be the FULL HTTPS URL
# This repository must contain a manifest*.* file for Parliament to read.
# (preferably in a .yaml format)
# For development/testing, the following sample repo can be used: https://github.com/AdobeDocs/parliament-docs-template
GATSBY_SOURCE = github.com/<source_org>/<source_repo>.git
GATSBY_SOURCE_BRANCH=master
# Strings starting with a "!" are considered ignore patterns. For example !CONTRIBUTING.md will tell the system to skip CONTRIBUTING.md
GATSBY_SOURCE_PATTERNS=**/*,!CONTRIBUTING.md
GATSBY_SOURCE_TITLE=My Docs Site
# Url for your analytics script
GATSBY_LAUNCH_SRC=//assets.adobedtm.com/<id>/launch-<id>.min.js
# NOTE: LOCAL_PROJECT_DIRECTORY is the absolute path to a local copy of the repository specified in $GATSBY_SOURCE
LOCAL_PROJECT_DIRECTORY=/absolute/path/to/docs/project
SWAGGER_SOURCE_PATTERNS=**/petstore.json,**/swagger.json
# used to mock out features that require a username
LDAP_USER=<your LDAP>
For Jenkins:
GATSBY_GIT_CORP_TOKEN = credentials('TOKEN')
# Repo URL in given format which you want to use to generate a microsite
GATSBY_SOURCE = 'github.com/<source_org>/<source_repo>.git'
# Repo URL in given format where you want to host the static html build output from Gatsby for Gihub Pages
GATSBY_TARGET = 'github.com/<target_org>/<target_repo>.git'
GATSBY_SITE_PATH_PREFIX = '/pages/<target_org>/<target_repo>' // Path Prefix for link relationship to work
GATSBY_SOURCE_BRANCH=master
# Strings starting with a "!" are considered ignore patterns. For example !CONTRIBUTING.md will tell the system to skip CONTRIBUTING.md
GATSBY_SOURCE_PATTERNS=**/*,!CONTRIBUTING.md
GATSBY_SOURCE_TITLE=My Docs Site
# Url for your analytics script
GATSBY_LAUNCH_SRC=//assets.adobedtm.com/<id>/launch-<id>.min.js
LOCAL_PROJECT_DIRECTORY=/absolute/path/to/docs/project
SWAGGER_SOURCE_PATTERNS=**/petstore.json,**/swagger.json
Clean environment
If you have previously built a production site or switching to a new local project, run this command to remove the .cache
directory.
yarn run clean
Start developing/authoring
Start a local instance of this project using the following command:
yarn run develop
Open the source code and start editing!
Your site is now running at http://localhost:8000
!
Note: You'll also see a second link: http://localhost:8000/___graphql
. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.
Open the my-default-starter
directory in your code editor of choice and edit src/pages/index.js
. Save your changes and the browser will update in real time!
Run unit tests
yarn run test:integration
Run end to end tests
gatsby clean
yarn run test:e2e
To simulate production tests first set the environment variable GATSBY_SITE_PATH_PREFIX
locally as it is required for production tests to run properly.
yarn run test:integration
Run end to end tests
gatsby clean
yarn run build:prod
yarn run test:e2e:ci
Contributions are welcomed! Read the Contributing Guide for more information.