mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-14 08:02:15 +03:00
docs: add SLA and reorder pages
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6240 GitOrigin-RevId: 406303a03e5258c20baa5c49f52be8d6262a7535
This commit is contained in:
parent
7b6dae7e8e
commit
9c48313f81
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_label: PR Review Checklist
|
||||
sidebar_position: 30
|
||||
sidebar_position: 40
|
||||
---
|
||||
|
||||
# PR Checklist
|
||||
|
@ -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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "Docusaurus MDX Guide",
|
||||
"position": 40,
|
||||
"position": 50,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Docusaurus Markdown Guide Index"
|
||||
|
30
docs/wiki/sla.mdx
Normal file
30
docs/wiki/sla.mdx
Normal file
@ -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.
|
||||
|
||||
:::
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "Style",
|
||||
"position": 50,
|
||||
"position": 60,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Documentation Style Guide Index"
|
||||
|
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user