Skip to content

Commit

Permalink
docs(website): add version to header, and documented branch flow (typ…
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg authored and Omri Luzon committed Nov 23, 2022
1 parent ed868f4 commit 9e44cba
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
11 changes: 10 additions & 1 deletion packages/website/README.md
@@ -1,5 +1,7 @@
# Website

[![Netlify Status](https://api.netlify.com/api/v1/badges/128d21c7-b2fe-45ad-b141-9878fcf5de3a/deploy-status)](https://app.netlify.com/sites/typescript-eslint/deploys)

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation
Expand All @@ -26,4 +28,11 @@ This command generates static content into the `build` directory and can be serv

## Deployment

The website is deployed automatically using Netlify. Each pull request into the `main` branch will have a unique preview deployment generated for it.
### Production

The website is deployed from the `website` branch automatically using Netlify.
That branch gets updated from the `main` branch whenever a new stable version is released (generally weekly).

### Pull Requests

Each pull request into the `main` branch will have a unique preview deployment generated for it.
6 changes: 6 additions & 0 deletions packages/website/docusaurusConfig.ts
Expand Up @@ -8,6 +8,7 @@ import type { UserThemeConfig as AlgoliaThemeConfig } from '@docusaurus/theme-se
import type { Config } from '@docusaurus/types';
import tabsPlugin from 'remark-docusaurus-tabs';

import { version } from './package.json';
import { generatedRuleDocs } from './plugins/generated-rule-docs';
import { rulesMeta } from './rulesMeta';

Expand Down Expand Up @@ -91,6 +92,11 @@ const themeConfig: ThemeCommonConfig & AlgoliaThemeConfig = {
label: 'Blog',
position: 'left',
},
{
position: 'right',
value: `v${version}`,
type: 'html',
},
{
to: 'play',
activeBasePath: 'play',
Expand Down

0 comments on commit 9e44cba

Please sign in to comment.