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

Some word-choice changes for easier reading #662

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

svalsdottir
Copy link
Contributor

@svalsdottir svalsdottir commented Mar 11, 2022

I'm getting familiar with how to make document updates, saw an opportunity to simplify the language in this one :)

What Changed

  • More plain language than before - easier for everyone to read, especially our many non-native-English speaking customers.

How To Test or Verify

  • This is my first document edit in GitHub, I'm trying to find how to preview it...

PR Checklist

Below are some checklists to follow for the correct procedure in different circumstance. The first list ("All PRs Checklist") should be followed for ALL PRs. The next 2 are additive to this list depending on what type of PR you are using.

For example: If you are submitting a content change to one of the support documents, your checklist would include the:

  • "All PRs Checklist"
  • AND the "Content Changes Checklist

If you are submitting a feature addition, enhancement, or bug fix, your checklist would include the:

  • "All PRs Checklist"
  • AND the "Development Changes Checklist"

All PRs Checklist

  • Give your pull request a meaningful name.
  • Use lowercase filenames.
  • Apply at least one team label according to which team is the content expert (ie. team-FE or team-SAZ)
  • Pull request approval from the FE team or content experts (see label applied above) that isn't the content creator.

Content Changes Checklist

  • Check that your article looks correct in the preview here or in a Netlify deploy preview.
  • Check the links in your article.
  • Check the images in your article (if there are any)
  • Check to make sure you are using markdown appropriately as outlined in examples/article.md in the root of the project directory and on the momentum doc's preface article
  • Check to make sure the Copy and Tone Guidelines are followed.

Development Changes Checklist (some checks are automatic github actions and will not be listed here. ie. "all tests pass")

  • The appropriate tests are created in cypress/ directory in the root of the project
  • The lighthouse score is passing according to the FE Support Docs' Service Outline SLI/SLOs

I'm getting familiar with how to make document updates, saw an opportunity to simplify the language in this one :)
@svalsdottir svalsdottir requested a review from jonambas March 11, 2022 21:49
@netlify
Copy link

netlify bot commented Mar 11, 2022

✔️ Deploy Preview for support-docs ready!

🔨 Explore the source changes: 2154565

🔍 Inspect the deploy log: https://app.netlify.com/sites/support-docs/deploys/622bc405e9f4770008a47848

😎 Browse the preview: https://deploy-preview-662--support-docs.netlify.app

@svalsdottir
Copy link
Contributor Author

@jonambas I'm not sure I'm doing this right - I've not been able to preview my changes yet. And not sure where I was meant to give it an "all lowercase file name"...

Copy link
Contributor

@jonambas jonambas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

2 participants