diff --git a/docs/wiki/checklist.mdx b/docs/wiki/checklist.mdx index 1945802f7dc..f8672dc52d9 100644 --- a/docs/wiki/checklist.mdx +++ b/docs/wiki/checklist.mdx @@ -1,6 +1,6 @@ --- sidebar_label: PR Review Checklist -sidebar_position: 30 +sidebar_position: 40 --- # PR Checklist diff --git a/docs/wiki/contributions.mdx b/docs/wiki/contributions.mdx index ce51a733283..0eb8d7200cc 100644 --- a/docs/wiki/contributions.mdx +++ b/docs/wiki/contributions.mdx @@ -1,6 +1,6 @@ --- sidebar_label: Contributing to Docs -sidebar_position: 20 +sidebar_position: 30 --- import Thumbnail from '@site/src/components/Thumbnail'; @@ -36,9 +36,9 @@ available to employees at Hasura. We utilize these two repos so we can maintain provide an undisturbed repository to which the community has access. As changes are merged into our private repository, they're reflected in the OSS version as well. -Anywhere where there are differences in procedure between community contributions and those of Hasurians, tabs can be found. -If you're a member of the community looking to contribute to docs, follow the **Community Member** instructions inside -each step. Alternatively, Hasurians should follow the instructions which fall under their tab. +Anywhere where there are differences in procedure between community contributions and those of Hasurians, tabs can be +found. If you're a member of the community looking to contribute to docs, follow the **Community Member** instructions +inside each step. Alternatively, Hasurians should follow the instructions which fall under their tab. :::info Note @@ -147,8 +147,8 @@ yarn start ### Step 3: Make your local changes -We have a [comprehensive-yet-continually-evolving style guide](/wiki/category/style/). We ask that you reference it as you -begin formatting your docs contribution. +We have a [comprehensive-yet-continually-evolving style guide](/wiki/category/style/). We ask that you reference it as +you begin formatting your docs contribution. If you don't want to go piece-by-piece in the style guide, find a page of documentation you think works well and use it as a template. diff --git a/docs/wiki/docusaurus-mdx-guide/_category_.json b/docs/wiki/docusaurus-mdx-guide/_category_.json index 87d92ebc9b2..c817e981278 100644 --- a/docs/wiki/docusaurus-mdx-guide/_category_.json +++ b/docs/wiki/docusaurus-mdx-guide/_category_.json @@ -1,6 +1,6 @@ { "label": "Docusaurus MDX Guide", - "position": 40, + "position": 50, "link": { "type": "generated-index", "title": "Docusaurus Markdown Guide Index" diff --git a/docs/wiki/sla.mdx b/docs/wiki/sla.mdx new file mode 100644 index 00000000000..2fb5630cccf --- /dev/null +++ b/docs/wiki/sla.mdx @@ -0,0 +1,30 @@ +--- +sidebar_label: Docs SLA +sidebar_position: 20 +--- + +# Hasura Docs SLA + +In order to maintain both the quality of docs and the sanity of the docs team, we follow these guidelines: + +- **Team approval**: When you raise a docs PR, it needs to be approved by someone from your team first. +- **Docs team review**: After your team's approval, ask for a docs team review in the + [#team-docs](https://hasurahq.slack.com/archives/C015EA71MU0) channel. You should already have an assigned docs team + member on GitHub. The docs team will review the PR within two business days of your team's review. Sometimes we can + merge the PR after that, and often we suggest changes. + +**If we assume that there are 1-2 review cycles, the docs PR needs to come to the docs team at least 4-5 business days +before the release.** + +- **Late PRs**: If the docs PRs come in late, we will decide on one of two options: + + - We will wait to release these docs until the PRs have been adequately reviewed and live up to the quality standards. + - We will push out the first version in the spirit of "Some docs are better than no docs." In this case, we expect you + to submit a follow-up PR within 1-2 business days. + +:::info Note + +The above is about feature documentation that sometimes includes adding one or several pages. As usual, we will handle +minor fixes and improvements at the earliest opportunity. + +::: diff --git a/docs/wiki/style/_category_.json b/docs/wiki/style/_category_.json index 3923da88788..15f90a8a750 100644 --- a/docs/wiki/style/_category_.json +++ b/docs/wiki/style/_category_.json @@ -1,6 +1,6 @@ { "label": "Style", - "position": 50, + "position": 60, "link": { "type": "generated-index", "title": "Documentation Style Guide Index" diff --git a/docs/wiki/working-with-docusaurus.mdx b/docs/wiki/working-with-docusaurus.mdx index 8eafaba971c..c1edfa51327 100644 --- a/docs/wiki/working-with-docusaurus.mdx +++ b/docs/wiki/working-with-docusaurus.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 60 +sidebar_position: 70 --- # Working with Docusaurus @@ -92,8 +92,8 @@ slug: index ## Styling -The majority of styles is controlled through CSS variables - there is a heavy list available (use the browser inspect element to -see the complete list). +The majority of styles is controlled through CSS variables - there is a heavy list available (use the browser inspect +element to see the complete list). These variables can be overridden and new custom styles to be added in `src/css/custom.scss` and `src/css/_custom-dark.scss` for light and dark themes respectively.