How does this thing work?

• Stack
  • JAMstack
  • Tools
  • Gatsby plugins
  • Gatsby theme
  • Hosting and deployment
• Local development
• Directory structure
• Github actions

At a high level, docs.newrelic.com is built with React and MDX. It uses Gatsby as a static site generator and is hosted on AWS Amplify.

JAM stands for Javascript, APIs & Markup. A core part of the site architecture is Gatsby which is uses as a static-site generator. Pages are built by combining Markup (MDX) and Javascript (React) and hosted as static HTML files.

There is no back-end or CMS powering the site.

In addition to the technologies listed above, we use a number of Gatsby plugins. In addition to established third-party plugins, we've also created a few custom plugins to handle specific tasks. For a complete list of plugins, check out our package.json file.

newrelic/gatsby-theme-newrelic

New Relic has developed a Gatsby theme which includes components and configuration shared across several website. The Open Source and Developer site both make use of this theme. For more information on how to use the components and configuration, refer to the README.

The site is currently hosted on AWS Amplify (and is connected to the repository via a webhook). To deploy a new version of the site, simply merge into main (our mainline branch). Amplify will:

1. Build the site by running yarn build:production.
2. If the build succeeds, deploy the new version.
3. If the build fails, do keep the previous version deployed.

Additionally, whenever a pull request is created, a "preview" environment will be spun up. A link for this environment can be found in the "checks" tab for the pull request.

For more information about our CD settings, check out the amplify.yml file. For information about other CI processes, see Github actions below.

To run the project locally, you will need the following dependencies:

• Node 12.x
• Yarn

To get the project running locally, follow these steps:

1. Clone the repository.
2. Install the dependencies by running yarn.
3. Start the development server by running yarn start.

The first time you start the server on a machine, it will take a while to run. Subsequent runs should be faster (Gatsby caching).

For more information, see CONTRIBUTING.md.

Here is a list of the commonly-used directories (see below for a description of each):

.github/workflows/
codemods/
gatsby/
plugins/
rehype-plugins/
scripts/actions/
src/
  | @newrelic/gatsby-theme-newrelic/
  | announcements/
  | components/
  | content/
      | docs/
      | whats-new/
  | data-dictionary/events/
  | data/
  | hooks/
  | i18n/
      | content/
      | nav/
      | translations/
  | images/
  | layouts/
  | manual-edits/
  | nav/
  | pages/
  | templates/
  | utils/
static/

Content coming soon.