graphql-engine icon indicating copy to clipboard operation
graphql-engine copied to clipboard

Standard capitalization of documentation headings (close #8885)

Open IllogicalTree opened this issue 3 years ago • 2 comments
trafficstars

Description

This commit changes all of the markdown headings in the documentation to be capitalized as per the styling guidelines here in relation to issue #8885.

Changelog

Component : documentation

Type: enhancement

Product: community-edition

Related Issues

#8885 #9072

Solution and Design

To achieve this task and to avoid both typos and/or missed files, I threw a quick program together to do this automatically which can be found here for those curious.

Steps to test and verify

A large selection of the changed documentation files have been manually reviewed to verify the change works as intended.

Catalog upgrade

Does this PR change Hasura Catalog version?

  • [x] No
  • [ ] Yes
    • [ ] Updated docs with SQL for downgrading the catalog

Does this PR add a new Metadata feature?

  • [x] No
  • [ ] Yes
    • Does run_sql auto manages the new metadata through schema diffing?
      • [ ] Yes
      • [x] Not required
    • Does run_sql auto manages the definitions of metadata on renaming?
      • [ ] Yes
      • [x] Not required
    • Does export_metadata/replace_metadata supports the new metadata added?
      • [ ] Yes
      • [x] Not required

GraphQL

  • [x] No new GraphQL schema is generated
  • [ ] New GraphQL schema is being generated:
    • [ ] New types and typenames are correlated

Breaking changes

  • [x] No Breaking changes

  • [ ] There are breaking changes:

    1. Metadata API

      Existing query types:

      • [ ] Modify args payload which is not backward compatible
      • [ ] Behavioural change of the API
      • [ ] Change in response JSON schema
      • [ ] Change in error code
    2. GraphQL API

      Schema Generation:

      • [ ] Change in any NamedType
      • [ ] Change in table field names

      Schema Resolve:-

      • [ ] Change in treatment of null value for any input fields
    3. Logging

      • [ ] Log JSON schema has changed
      • [ ] Log type names have changed

IllogicalTree avatar Oct 05 '22 17:10 IllogicalTree

Beep boop! :robot:

Hey @IllogicalTree, thanks for your PR!

One of my human friends will review this PR and get back to you as soon as possible.

Stay awesome! :sunglasses:

hasura-bot avatar Oct 05 '22 17:10 hasura-bot

Hi @IllogicalTree Thanks for the PR and the smart way of addressing it.

However we're going to have to include a few extra rules in your program if you can please:

  • Restrict changes to only docs/docs and docs/wiki
  • In H1s words like and, with, in, on, to, a, an etc shouldn't be capitalised eg: Run Hasura GraphQL Engine on AWS
  • in H2s and up which is sentence cased anything which is a Hasura feature should still be Title Cased eg: Actions, Remote Schemas, Streaming Subscriptions, Event Triggers, Scheduled Triggers
  • Nothing in any code blocks should be changed
  • Comments which are not rendered by Docusaurus should not be changed

That's what I can see for now. Hope this is cool. Thanks

seanparkross avatar Oct 07 '22 14:10 seanparkross

Beep boop! :robot:

Hey @IllogicalTree!

Sorry that your PR wasn’t merged.

Do take a look at any of the other open issues to see if you’d like to take something up! We’re around on Discord if you have any questions :smile:

hasura-bot avatar Dec 14 '22 13:12 hasura-bot