Skip to content

docs(website): add version to header, and documented branch flow #6055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 22, 2022
Merged

docs(website): add version to header, and documented branch flow #6055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
773d2eb
docs(website): add version to header, and documented branch flow
JoshuaKGoldberg Nov 21, 2022
520d318
Merge branch 'main' into website-docs-branch-website
JoshuaKGoldberg Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion packages/website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
View file
Open in desktop
Original file line number Diff line number Diff line change
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