Skip to content
This repository has been archived by the owner on Dec 8, 2023. It is now read-only.

Commit

Permalink
feat: update readme to include workflows and path prefixing
Browse files Browse the repository at this point in the history
  • Loading branch information
aswanson-nr committed Jan 27, 2022
1 parent 27a9850 commit 34e733a
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,19 @@ yarn serve

Your site is now running at `http://localhost:9000`!

### Path prefix
This site supports using a path prefix, allowing the site to work as if it was exposed at `www.somewebsite.com/` while actually being exposed at `www.somewebsite.com/instant-observability`. The value of the prefix is defined in the `gatsby-config.js` file under the `pathPrefix` field.

To build to the with the path prefix enabled:
```shell
yarn build:production
```

To then serve the built site with path prefixing enabled:
```shell
yarn serve:production
```

## ✅ CI/CD
#### Gatsby Build Service
Verifies that your branch can be built and generates a preview build.
Expand All @@ -44,11 +57,20 @@ This check is required for merges into `main`.
#### Fetch-quickstarts
Runs every 4 hours to pull in new quickstarts from Nerdgraph (New Relic's GraphQL instance) and commit them to the `main` branch.

## ☁️ Hosting
#### Fetch related content
Runs every day to get various pages that relate to each quickstart from our vendor.

This site is build and hosted on Gatsby Cloud. [insert URL here]
## ☁️ Hosting

This site is built and hosted on Gatsby Cloud. [insert URL here]
Changes are published on pushes to `main`.

### Environment variables
|key|possible values|notes|
|-|-|-|
|`GATSBY_NEWRELIC_ENV`|`development` or `production`| Used by the [New Relic Gatsby Theme](https://github.com/newrelic/gatsby-theme-newrelic) to determine the running environment. Set to `production` on prod.|
|`PREFIX_PATHS`|`true` or `false`|Enables path prefixing during builds and deployments. Set to `true` on prod.|


## 🩹 Support

Expand Down

0 comments on commit 34e733a

Please sign in to comment.