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

W-14237985 mtf #232

Open
wants to merge 53 commits into
base: v1.1
Choose a base branch
from
Open

W-14237985 mtf #232

wants to merge 53 commits into from

Conversation

sathya0
Copy link
Contributor

@sathya0 sathya0 commented Oct 9, 2023

Writer's Quality Checklist

Before merging your PR, did you:

  • Run spell checker
  • Run link checker to check for broken xrefs
  • Check for orphan files
  • Perform a local build and do a final visual check of your content, including checking for:
    • Broken images
    • Dead links
    • Correct rendering of partials if they are used in your content
    • Formatting issues, such as:
      • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
      • Messed up tables
      • Proper indentation
      • Correct header levels
  • Receive final review and signoff from:
    • Technical SME
    • Product Manager
    • Editor or peer reviewer
    • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • If applicable, verify that the software actually got released

@sathya0 sathya0 self-assigned this Oct 9, 2023
@sathya0 sathya0 requested a review from a team as a code owner October 9, 2023 17:54
hannanelson
hannanelson previously approved these changes Oct 24, 2023
Copy link

@dhirsch1 dhirsch1 left a comment

Choose a reason for hiding this comment

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

In general, it would be better to specify which XML tag to use wen you are saying:

"add a line for...." or "add the following line" > "add the xxx tag"
When you say "add the following line," it is not clear which line you are referring to.

I may not have marked this until later in the doc.

Also, try to limit the use of admonitions.

dhirsch1
dhirsch1 previously approved these changes Nov 20, 2023
Copy link

@dhirsch1 dhirsch1 left a comment

Choose a reason for hiding this comment

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

In general, it would be better to specify which XML tag to use wen you are saying:

"add a line for...." or "add the following line" > "add the xxx tag"
When you say "add the following line," it is not clear which line you are referring to.

I may not have marked this until later in the doc.

Also, try to limit the use of admonitions.

dhirsch1
dhirsch1 previously approved these changes Nov 29, 2023
dhirsch1
dhirsch1 previously approved these changes Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants