Request updates to landing pages and hub pages

SME: tysonn

Hub pages are the top-level pages on docs.microsoft.com for your product. They are named index.md and contain HTML rather than markdown. These pages provide high-level messaging and navigation into the documentation from various "pivots". In a repo, these files exist within your top-level docset folder. Examples:

Landing pages are scoped to the service level (Azure) or to a technology level within the product. They are also named index.md and contain HTML rather than markdown. They are designed pages in a docs template. In a repo, these files exist in subfolders of the main docset. Examples:

All changes to landing pages and hub pages require review by the content team and by the APEX production team. The content team needs to approve the content changes, and the production team needs to review and approve the coding of the pages. The content team approvers are listed later in this article.

Major updates

Major updates, new pages, or design requests must be handled through a bug.

  1. File a bug for your change at https://msdnhelp. Select "Hub/Landing Page Updates".
  2. Bug is triaged to the appropriate content team approver.
  3. The content team approver notes their feedback in the bug.
  4. If the content team approver agrees to the change, they set the status to Approved and assign the bug to the APEX production team for action. If the bug is not approved, the content team approver closes the bug.
  5. The production team submits a pull request with the content. They @ mention the content team approvers.
  6. When the content team approver has approved the PR, the production team signs off.
  7. Pull request reviewers will verify that any PR that contains a landing or hub page update has clear comments indicating content team and production team sign off.

Minor updates

Minor landing and hub page updates can be handled through bugs or through pull requests.

  1. Create a pull request with your changes.
  2. @ mention the content team approver in your pull request to seek approval for the change.
  3. The content team approver notes their feedback in the pull request.
  4. If the content team approver agrees to the change, @ mention the APEX production team for a review of the changes. They will provide feedback or submit updates to ensure the changes are coded correctly. If the content team approver does not approve the change, close the pull request.
  5. When you have obtained approval from both the content team and the production team, sign off.
  6. Pull request reviewers will verify that any PR that contains a landing or hub page update has clear comments indicating content team and production team sign off.

If the PR comes from a content team approver, the production team must sign off to ensure it's done right.

Contextual index.md files

There are pages named index.md that occur deeper within doc sets; these pages are basic text/markdown pages authored by content teams. These sorts of index.md pages should be handled as normal technical content. Example:

Business approvers

See the business approvers and repos list.

Production team

Members of the following GitHub teams:

  • Microsoft/APEX-production
  • Microsfot/apex-production