partial submission for docs:capitalization of headings #8885

[catcecilia]

Description

I updated some of the docs to follow the capitalization guideline for the issue referenced below

The reason why I am submitting partial is because I noticed others are interested in doing it too. I want to make sure that no one is overlapping in work.

Changelog

Component : docs

Type: enhancement

Product: community-edition

Short Changelog

Partial docs update regarding capitalization of headings.

Long Changelog

Looked through and updated capitalization of headings in .md and mdx in:

• graphql-engine/

• graphql-engine/server

• graphql-engine/scripts

• graphql-engine/rfcs

• graphql-engine/packaging

• docs/

• docs/wiki

• docs/static

• docs/src

• docs/scripts

• docs/public

• docs/docs/

• docs/docs/subscriptions

• docs/docs/security

• docs/docs/schema

Related Issues

issue #8885

Solution and Design

Partial solution, working together to finish all of docs would be a good suggestion. Also, shouldn't all documentation be updated? Not just the docs directory?

Steps to test and verify

n/a

Limitations, known bugs & workarounds

Limitation is human error

Server checklist

Catalog upgrade

Does this PR change Hasura Catalog version?

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

Metadata

Does this PR add a new Metadata feature?

• [x] No
• [ ] Yes
  • Does run_sql auto manages the new metadata through schema diffing?
    • [ ] Yes
    • [ ] Not required
  • Does run_sql auto manages the definitions of metadata on renaming?
    • [ ] Yes
    • [ ] Not required
  • Does export_metadata/replace_metadata supports the new metadata added?
    • [ ] Yes
    • [ ] 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:

[hasura-bot]

Beep boop! :robot:

Hey @catcecilia, 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:

[CLAassistant]

All committers have signed the CLA.

[seanparkross]

Hey @catcecilia Just curious as to why you closed this? Looked like a great PR...?

[catcecilia]

I closed it because there was another naming convention issue which I hadn't taken account to posted under ( correct capitalization for hasura features #8884 )

I do not want to undo anyone's work so I'll be relooking at everything I've done over the weekend to make sure I did not made any incorrect lower cases in headings

[seanparkross]

Hi @catcecilia actually the other PR needs a lot of work because it was done with script which needs to take into account a lot of edge cases. Your PR would be a much better starting point actually. If you want to reopen and ping me I will review it. Yes?

[catcecilia]

Okay sounds good! I will go ahead and reopen it.

[seanparkross]

Hi Cat. The PR is looking good. Please could you just revert changes to anything outside the docs directory... eg:

[catcecilia]

Hi there, just did it. Thank you for your patience. I was figuring out how to use GitHub still when I edited directly vs editing on Github Desktop.

[Stefmore02]

Hey! @catcecilia

We truly appreciate your contribution to Hasura OSS during Hacktoberfest 2022! We'd love to send you some Hasura swag as a token of appreciation. Could you please send me an email to [email protected] with a reference of this PR so I can send you the swag form? ✨

[seanparkross]

@catcecilia I just merged master back because there were conflicts.

Please can you click and accept the CLA agreement in the message above before we're able to merge.

Thanks

[catcecilia]

@seanparkross done. my apologies on not agreeing to it sooner!

[hasura-bot]

Beep boop! :robot:

Awesome work @catcecilia!

Your changes were merged successfully. All of us at Hasura :heart: what you did.

Thanks again :hugs: