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

simplifying language, minor edits #683

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

Conversation

svalsdottir
Copy link
Contributor

@svalsdottir svalsdottir commented Sep 7, 2022

I wanted to improve the last paragraph, too, but I don't even understand it well enough - maybe someone else can give it a shot? It's really confusing:

Note: For single recipient transmissions: if an email address is suppressed the API response for the rejection will appear inline. However, if you are using multiple recipient transmissions, the API response will initially accept addresses which will be suppressed later in the message generation process. For multiple recipient transmissions which contain a suppressed address, you will notice that an injection event is recorded before the ultimate suppression, but an injection event is not recorded for a single recipient, inline suppression.

  • Give your PR a recognizable title. For example: "FE-123: Add new prop to component" or "Resolve Issue Create new-pricing-increases-costs #123: Fix bug in component"
  • Your PR title will be visible in changelogs

What Changed

  • What changes does this PR propose?
  • Provide screenshots or screen recordings for any visual changes.

How To Test or Verify

  • Describe any steps that may help reviewers verify changes.
  • Anything beyond basic unit testing, such as assistive tech usage, or special interactions.

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 wanted to improve the last paragraph, too, but I don't even understand it well enough  - maybe someone else can give it a shot? It's really confusing: 

**Note**: For single recipient transmissions: if an email address is suppressed the API response for the rejection will appear inline. However, if you are using multiple recipient transmissions, the API response will initially accept addresses which will be suppressed later in the message generation process. For multiple recipient transmissions which contain a suppressed address, you will notice that an injection event is recorded before the ultimate suppression, but an injection event is not recorded for a single recipient, inline suppression.
@netlify
Copy link

netlify bot commented Sep 7, 2022

Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 692b908
🔍 Latest deploy log https://app.netlify.com/sites/support-docs/deploys/6318f19e19bb50000864fa83
😎 Deploy Preview https://deploy-preview-683--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor Author

@svalsdottir svalsdottir left a comment

Choose a reason for hiding this comment

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

The last paragraph still needs work, it's very confusing, but I don't understand it well enough to make meaningful changes... -_-

@svalsdottir svalsdottir changed the title Simplifying language, minor edits simplifying language, minor edits Sep 7, 2022
@svalsdottir svalsdottir added the team - TR Transmissions team is the subject matter expert and need to approve this PR label Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👀 needs review team - TR Transmissions team is the subject matter expert and need to approve this PR type: content change
Projects
None yet
1 participant