Reviews on SuperOfficeDocs

• 2 minutes to read
 • 2 minutes to read

Reviews can be many things. This article focuses on the required steps to get a proposed change accepted and published to docs.superoffice.com.

The main objectives of our mandatory pull request (PR) reviews and automatic tests are to ensure that content is easy to find, easy to understand, and easy to use and that changes don't cause the build pipeline to fail or the site to break.

I'm a contributor, translator, or content author

To incorporate your proposed changes, we'll merge your pull request (PR) with the main branch after approving the PR.

  1. Create the PR (request a review). This signals that you consider your work done.

    Note

    If you want intermittent input from a co-author or a subject matter expert (SME) before you're done, contact them directly or @ mention them in a comment on the GitHub issue.

  2. When you receive GitHub notifications on the PR, study the comments and incorporate the feedback.

    It is not uncommon for this step to involve several discussions and fixes.

I'm a reviewer

As a reviewer, you'll do one or more of the following tasks:

  • Comment on the changes proposed in PR.
  • Approve the changes.
  • Request further changes (blocks merge).

How to comment or start a review

What to check

  • Markdown formatting - no linting errors
  • Style guide
  • Automatic tests should pass.
  • Local DocFX build should pass and not report broken links. Modified and new pages should look OK on localhost.
  • Reference to deleted pages should be removed from toc and other content.
  • Reference to moved or renamed pages should be updated so no links break.
  • Images and other resources used only in a deleted file should also be deleted.