Skip to main content

PR Checklist and Deploy

This is taking about how to deploy my documents.

You can open PR from develop branch or on your own feature branch. If you are in hurry, you may commit it into the main branch directly. When you merge it to the main branch, the pipeline will publish the whole docs to internal GitHub page.

Documents need be well-structured. It won't build if you have a broken link or close tag issue. Here is checkpoint.

PR Review​

  • Check for spelling or grammatical errors.
  • Check that <h1> is title case.
  • Check that <h2>s and below are sentence case.
  • Check that MDX features (e.g., make sure you have right syntax).
  • Check for broken internal links.
  • Check for broken external links.
  • Check for broken images.
  • Check for broken code snippets.

Publish Process​

Everybody is different, and we all review PRs in our way. However, there are some common elements we examine and questions we ask ourselves when reviewing a PR. Our goal in providing this document is to give you a guide how we quickly involve in a specific project technically. You should think your contribution as a 'techincal writer' how we can simplify a document and we want to ensure developers quickly find what they need, understand it.