docs icon indicating copy to clipboard operation
docs copied to clipboard

[Improvement]:

Open docs-bot opened this issue 2 years ago • 2 comments

What article(s) is affected?

These reusables:

  • data/reusables/secret-scanning/partner-secret-list-private-repo.md
  • data/reusables/secret-scanning/partner-secret-list-public-repo.md
  • data/reusables/secret-scanning/secret-list-private-push-protection.md

Describe the desired docs changes and the problem they solve for customers.

We should update the capitalization in the reusables listed above to be consistent with the style guide. Product names (e.g. Atlassian) and abbreviations (e.g. API) should remain capitalized, but other things (e.g. Refresh Token) should be lower case. For example,DevCycle Client API Key becomes DevCycle client API key.

examples: DevCycle Client API Key becomes DevCycle client API key Ionic Refresh Token becomes Ionic refresh token GitHub OAuth Access Token becomes GitHub OAuth access token

docs-bot avatar Oct 24 '22 20:10 docs-bot

Hi. Could you provide a link to the style guide you are referring to? I can understand the examples provided and I assume Ionic Refresh Token becomes Ionic Refresh token should be Ionic Refresh Token becomes Ionic refresh token..?

ishuen avatar Oct 25 '22 23:10 ishuen

Hi. Could you provide a link to the style guide you are referring to?

Yes! We follow the Microsoft style guide for capitalization: https://learn.microsoft.com/en-us/style-guide/capitalization

I can understand the examples provided and I assume Ionic Refresh Token becomes Ionic Refresh token should be Ionic Refresh Token becomes Ionic refresh token..?

Yes, sorry for the confusion. I will update the body above.

skedwards88 avatar Oct 26 '22 00:10 skedwards88

Closing for now pending some internal discussion.

skedwards88 avatar Oct 28 '22 16:10 skedwards88