Commit Graph

21 Commits

Author SHA1 Message Date
Marion Schleifer
7dffbc6a0d docs: add bullet point on infinitive verb form in headings to docs wiki
## Description

This PR adds a bullet point on using the infinitive verb form in docs headings to the docs wiki.

## Quick link

[/docs/wiki/style/headings](https://marion-docs-update-wiki-to-u.hasura-docs-mono.pages.dev/docs/wiki/style/headings/)

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7397
GitOrigin-RevId: 88b38d6c771f8e9fc7a70189cea15e6c9caf9f57
2022-12-27 14:49:31 +00:00
Marion Schleifer
6fad57dc3b docs: update title / sidebar capitalization & use infinitive verb form in headings (close #8885)
## Description

Close: https://github.com/hasura/graphql-engine/issues/8885.

This PR introduces the following changes:
- Capitalize `#1` headings.
- Change sidebar labels to only capitalize features.
- Add missing 'Cloud & EE:' (example) information to title to show in browser tabs.
- Use infinitive verb form in sidebar and `#1` headings to make it consistent with the rest of docs and to save space.
- Updated the `data-federation/data-federation-types` page.

Question to the reviewer:
- `Use infinitive verb form in sidebar and #1 headings`: Should we add this to the wiki?

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7365
GitOrigin-RevId: 309156a0e7c945edaab950e347025b9e5e1ea9e7
2022-12-23 14:28:26 +00:00
Marion Schleifer
dc0dc30a06 docs: capitalize hasura features
## Description

[Jira ticket](https://hasurahq.atlassian.net/jira/software/projects/DOCS/boards/19?selectedIssue=DOCS-102).

This PR capitalizes Hasura features based on our [feature capitalization guide on the docs wiki](https://hasura.io/docs/wiki/style/hasura-features/).

It also introduces some linting by prettier.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7260
Co-authored-by: Samir Talwar <47582+SamirTalwar@users.noreply.github.com>
Co-authored-by: Luca Restagno <59067245+lucarestagno@users.noreply.github.com>
Co-authored-by: hasura-bot <30118761+hasura-bot@users.noreply.github.com>
Co-authored-by: Gil Mizrahi <8547573+soupi@users.noreply.github.com>
Co-authored-by: Stefano Magni <173663+NoriSte@users.noreply.github.com>
Co-authored-by: Daniel Harvey <4729125+danieljharvey@users.noreply.github.com>
Co-authored-by: Abby Sassel <3883855+sassela@users.noreply.github.com>
Co-authored-by: Daniele Cammareri <5709409+dancamma@users.noreply.github.com>
Co-authored-by: Brandon Martin <40686+codedmart@users.noreply.github.com>
GitOrigin-RevId: 5946f313cb44c639fac61e6c7fb44f704ee2a709
2022-12-19 20:03:55 +00:00
Rob Dominguez
8b4374202f docs: add docs devcontainer
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7296
GitOrigin-RevId: 68d9ac0bc8697aad0661480b33f65949ffdc8a80
2022-12-16 17:39:29 +00:00
Marion Schleifer
5b38518a64 docs: update yarn version in docs wiki
## Description

Tim (Head of Security) made me aware that we're linking to an [old version of yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) in our [docs wiki](https://hasura.io/docs/wiki/contributions/#mise-en-place). This PR updates to the [most recent docs](https://yarnpkg.com/getting-started/install).

## Quick links

[docs/wiki/contributions](https://ae91bccf.hasura-docs-mono.pages.dev/docs/wiki/contributions/#mise-en-place)

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7239
GitOrigin-RevId: f48ef559a6f56dde0f35a444a8e3c92c8454b170
2022-12-13 13:11:08 +00:00
Sean Park-Ross
a7584ccd79 Docs: Wiki add Hasura features and headings info
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6848
GitOrigin-RevId: ac23388362bcb118f9ee4d8d539adb161835070f
2022-11-15 16:18:39 +00:00
hasura-bot
659b340ffa partial submission for docs:capitalization of headings #8885
GITHUB_PR_NUMBER: 9072
GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/9072

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6201
Co-authored-by: Phuong-Cat Ngo <44314126+catcecilia@users.noreply.github.com>
GitOrigin-RevId: 96fa8807ded210e3d384cb7d4181088804c01fb6
2022-10-28 17:42:52 +00:00
Rob Dominguez
712d3e4a9d Docs: Reorganize guides, tutorials, resources section
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5273
Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com>
GitOrigin-RevId: c6b7bdaba648d49f37c315a5dd53497f42b6cbd6
2022-10-28 14:00:51 +00:00
Rob Dominguez
35ce169821 docs: add tl;dr and improve page structure
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6345
GitOrigin-RevId: 0050ee4884713d67059145436cf8c5de64ded896
2022-10-13 17:00:17 +00:00
Rob Dominguez
9c48313f81 docs: add SLA and reorder pages
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6240
GitOrigin-RevId: 406303a03e5258c20baa5c49f52be8d6262a7535
2022-10-07 16:43:12 +00:00
Sean Park-Ross
494e270227 Docs: Wiki Restructure and remove Sphinx RST - WIP
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6059
GitOrigin-RevId: c527d01b7af8ef98fa3859930115ec44d993e444
2022-10-07 13:58:26 +00:00
Sean Park-Ross
1dc95b8c4a Docs: Wiki add documentation 'mission statement'
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6051
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
GitOrigin-RevId: 686ba92c48e15a43f37d28308730f7073e327b7f
2022-10-07 13:16:15 +00:00
Rob Dominguez
0fdbca8d3e docs: add PR checklist
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6084
GitOrigin-RevId: c55f9a2935a270a2faa4c937bf0bada495772120
2022-09-28 13:06:36 +00:00
Rikin Kachhia
e369f567c3 docs: add support for showing section local TOC
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5941
GitOrigin-RevId: e05b5d60624d755dc38d662919bde55826cde434
2022-09-21 14:38:40 +00:00
Rob Dominguez
18f437d265 Docs: update contributing guide
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5778
GitOrigin-RevId: 6af33faa0792065f410cb76285f55f6318ff80a6
2022-09-12 16:26:03 +00:00
Rob Dominguez
ee0b447cd5 docs: update contributing guides
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5703
GitOrigin-RevId: ab94acb82739b132a6685c1b030bde2d37541ab9
2022-09-01 13:54:20 +00:00
Rob Dominguez
acc90587b4 docs: add runbook to wiki
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5464
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
GitOrigin-RevId: 9f2aba315fd08d3d63c4c9913525817e52096a95
2022-08-23 15:30:23 +00:00
Rob Dominguez
8602d1cf1c Docs: reorganize image folders after restructure
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5297
GitOrigin-RevId: a9403c873777a48ac0fc27f07a82c4cbb793f982
2022-08-03 16:26:40 +00:00
Marion Schleifer
ee846db056 docs: epic restructure
[Preview link](https://marion-docs-restructure.hasura-docs-mono.pages.dev/docs/latest/index/)

This PR is a complete restructure of documentation including the following:
- Merge [core](https://hasura.io/docs/latest/graphql/core/index/) and [cloud](https://hasura.io/docs/latest/graphql/cloud/index/) docs
- Integrate [enterprise](https://docs.ee.hasura.io/) docs
- Flip [database section](https://hasura.io/docs/latest/graphql/core/databases/index/)
- Much more

@robertjdominguez @seanparkross please add improvements and link to the sections that you've updated, so that it's easy to find for reviewers.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4882
Co-authored-by: surendran82 <26085612+surendran82@users.noreply.github.com>
Co-authored-by: Abby Sassel <3883855+sassela@users.noreply.github.com>
Co-authored-by: Sean Park-Ross <94021366+seanparkross@users.noreply.github.com>
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com>
GitOrigin-RevId: 897191003a5e20dcc525b15e571725a34dc7d76e
2022-07-20 16:36:00 +00:00
Sean Park-Ross
7a552d34da docs: wiki style section
**WIP**

## Description ✍️
Adding a style section to the documentation wiki.

This is a distillation and continuation of the notes started by @marionschleifer and @rikinsk at https://docs.google.com/document/d/1lD7IVEjtv5Sf9BaVqzefLywG-kNpuM40I84ThIUSmwg/edit

* _Everything is very much in a WIP stage._

* Everything is on one page for now, but if it warrants it, each sections could be broken out into separate parts under a main `style` section.

@robertjdominguez Please let me know your thoughts too.

**Anyone** please feel free to edit and push to this branch.

- Sean

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4642
Co-authored-by: parklifeio <33491775+parklifeio@users.noreply.github.com>
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
GitOrigin-RevId: 48a26500114efcef22278d4e673ce0289bd7d7db
2022-06-23 09:45:35 +00:00
Rikin Kachhia
cc30f08f6e docs: move docs-new to docs
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4261
GitOrigin-RevId: 3d80068acdd61b5350fc36ec3444db47508f9c09
2022-04-13 12:01:50 +00:00