Create scaffolding : GitHub

This guide describes creating placeholder files, for the MicrosoftDocs/learn-pr GitHub repository (repo), by using the Docs Scaffolding extension in Visual Studio Code (VSC).

Topics in this guide

Install Docs Scaffolding extension

  1. Open VSC, select Extensions icon from the left sidebar menu.
  2. In the “Search Extensions” field, enter docsmsft.docs-scaffolding.
  3. Select and install the docsmsft.docs-scaffolding extension.

Note: For help installing the Docs Scaffolding extension, refer to https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-scaffolding.

Fork and clone a repository

  1. Open a browser, then sign into GitHub.
  2. On your GitHub landing page, follow the Single Sign-On link (SSO), then provide your v- credentials.

  3. Go to the repo you want to fork.

    For example, go to https://github.com/MicrosoftDocs/learn-pr/tree/0f454b7bd5c67b278a71c9b7eb4c3caa84dfe18e.

  4. Choose Fork.
  5. Clone your fork onto your computer (locally).

Note: For help with forking and cloning, refer to Fork a repository.

Create a new branch

  1. Open your local clone in VSC.

  2. In VSC, create a new branch.

    For example, create a new branch named NEW-module-name.

  3. In the VSC Explorer pane (left sidebar), navigate to subfolder you require.

    For example, navigate to the subfolder ~/learn-pr/learn-pr/student-evangelism/.

  4. Add a new folder to store the files for each module.

    For example, create a new folder named tech-resiliency.

Add scaffolding files

  1. In VSC Explorer, navigate into newly created folder.

    For example, navigate to the folder ~/learn-pr/learn-pr/student-evangelism/tech-resiliency.

  2. In VSC Explorer, right-select, then choose Learn: Create module in NEW folder.

    For example, from inside the tech-resiliency folder, right-select then choose Learn: Create module in NEW folder.

  3. From the Select module pattern dialog, choose Standard.
  4. Add a name for the module, then choose ENTER.

Edit, save and push files

  1. Edit the scaffolding/ placeholder files in VSC as necessary.
  2. Save, stage, and commit your file changes.
  3. Push the files to your fork on GitHub.

  4. On GitHub, create new pull request (PR) and configure PR as follows:

    • merge from your fork > your branch
    • merge into the MicrosoftDocs/learn-pr repo > master branch

Note: For links to useful resources, refer to the Contributing to Microsoft Docs section of Links to useful resources.

Appendices

Check the following supplementary Appendices for more details and context.

⇠ Invite collaborator

Pull requests overview ⇢