Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v6.1] Editorial Pass/Review - Home #6544

Merged
merged 17 commits into from
Apr 22, 2021
Merged

[v6.1] Editorial Pass/Review - Home #6544

merged 17 commits into from
Apr 22, 2021

Conversation

inertial-frame
Copy link
Contributor

@inertial-frame inertial-frame commented Apr 21, 2021

This PR supports: #6534 and represents a quick editorial pass through the home docs!

In general, I tried to use my best judgement. I tried to avoid ruling on docs-wide conventions except where there was already some pattern implicit to an article (header casing in "Getting Started" for example).

Specifically:

  1. Corrected typos.
  2. Oxford commas.
  3. Added tic marks to assist with user skimming and search.
  4. Rewording in several places to improve grammar.
  5. Stylistic improvements. (IMO these improve the readability and ease in reading the docs.)

I avoided making any significant changes to content (since I'm still onboarding and learning about everything). I figure once the team has firmly decided on best docs practices and best approaches to those (plugin or manual edit, etc.) a greater effort can be made.

Wanted to get these changes in early on since this is the main landing "concept module" (home) for the current docs. Am happy to squash the merges. Figured it's fine to condense these into one PR since most changes are minor.

I'll work my way through the rest of 6.1 in subsequent PR's.

@klizhentas klizhentas enabled auto-merge (squash) April 22, 2021 03:00
@klizhentas
Copy link
Contributor

Looks good, you'd have to backport to branch/v6 and master + fix the linter errors:

content/docs/pages/faq.mdx

163 | 85:1-85:51 warning Marker style should be - unordered-list-marker-style remark-lint
164 | 86:1-86:35 warning Marker style should be - unordered-list-marker-style remark-lint
165 | 87:1-87:31 warning Marker style should be - unordered-list-marker-style remark-lint

@klizhentas
Copy link
Contributor

@webvictim can we please give Adam access to drone logs view? @russjones can we make Adam's account docs code owner for branches 4.4, 5, 6, 6.1 and master?

@webvictim
Copy link
Contributor

@klizhentas Drone access is gated on the same permissions as Github, so he should be able to see them if he has read/write access to the repo.

@inertial-frame Can you see https://drone.gravitational.io/gravitational/teleport/10259/2/3?

@inertial-frame
Copy link
Contributor Author

inertial-frame commented Apr 22, 2021

@webvictim , @klizhentas - thanks! I can. Let's chalk that up to getting familiar with the CI/CD pipeline? 😬 🤦‍♂️ I'll correct those issues here and rebase.

Edit: QQ - is force-pushing preferred? I clicked the update/merge button. Thanks!

@klizhentas klizhentas merged commit 99f4ab6 into branch/v6.1 Apr 22, 2021
@klizhentas klizhentas deleted the adam/docs/edits branch April 22, 2021 14:52
klizhentas pushed a commit that referenced this pull request Apr 22, 2021
* docs: correct footnote
* docs: consistent 2fa
* docs: consistent sentence header casing
* docs: port tics
* docs: correct proper noun
* docs: slightly improve prereqs
* docs: reword limitations
* docs: correct wording, typos
* docs: improve getting started page
* docs: improve user manual
* docs: casing in adopters page
* docs: oxford commas
* docs: improved faq
* docs: tsh in tic marks
* docs: admin and prod guide
klizhentas pushed a commit that referenced this pull request Apr 22, 2021
* docs: correct footnote
* docs: consistent 2fa
* docs: consistent sentence header casing
* docs: port tics
* docs: correct proper noun
* docs: slightly improve prereqs
* docs: reword limitations
* docs: correct wording, typos
* docs: improve getting started page
* docs: improve user manual
* docs: casing in adopters page
* docs: oxford commas
* docs: improved faq
* docs: tsh in tic marks
* docs: admin and prod guide
klizhentas pushed a commit that referenced this pull request Apr 22, 2021
* docs: correct footnote
* docs: consistent 2fa
* docs: consistent sentence header casing
* docs: port tics
* docs: correct proper noun
* docs: slightly improve prereqs
* docs: reword limitations
* docs: correct wording, typos
* docs: improve getting started page
* docs: improve user manual
* docs: casing in adopters page
* docs: oxford commas
* docs: improved faq
* docs: tsh in tic marks
* docs: admin and prod guide
klizhentas pushed a commit that referenced this pull request Apr 22, 2021
* docs: correct footnote
* docs: consistent 2fa
* docs: consistent sentence header casing
* docs: port tics
* docs: correct proper noun
* docs: slightly improve prereqs
* docs: reword limitations
* docs: correct wording, typos
* docs: improve getting started page
* docs: improve user manual
* docs: casing in adopters page
* docs: oxford commas
* docs: improved faq
* docs: tsh in tic marks
* docs: admin and prod guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants