Contribute to NetApp technical content in GitHub Edit on GitHub Request doc changes

Contributors akseldavis netapp-bcammett

The documentation for several of NetApp’s products and services are open source. This enables you to directly contribute to the content to make improvements, corrections, and suggestions. All you need is a GitHub account and a little initiative.

You can edit a page directly or request us to make the changes. If you need help with our writing style and syntax, use these resources:

Steps
  1. If you don’t already have a GitHub account, create one from github.com.

  2. Log in to your GitHub account.

  3. Using a browser, open the page that you want to contribute.

    You can edit the page directly or request changes to the page.

  4. To edit a page:

    1. Click Edit on GitHub next to the page title.

      Edit on GitHub

    2. Click the pencil icon and start editing the content.

      The content is written in AsciiDoc, a lightweight markup language.

      Pencil icon

    3. To commit changes, scroll down the page, select Create a new branch for this commit and start a pull request, then click Propose file change.

      GitHub automatically fills in a branch name (for example, username-patch-n) for the change.

      Propose file change

    4. Provide a comment about the edit that you made, then click Create pull request.

      Create pull request

      After you propose the changes, we’ll review them and merge the changes into the GitHub repository.

      You can also view the status of the pull request by clicking Pull requests on the top banner next to the GitHub search box:

      Pull request tab

  5. To request changes to a page:

    1. Click Request doc changes next to the page title.

      Request doc changes

      A text box appears, enabling you to provide request details.

    2. Provide details in the text box, and then click Submit new issue to create an issue for your request.

      The text box is prepopulated with the title and URL for the page. Don’t delete this information.

      Submit new issue

      Opening an issue enables collaboration through GitHub comments. You receive email notifications based on the preferences you indicated in your GitHub account settings.

      You can also view the status of the request by clicking Issues on the top banner next to the GitHub search box:

      Issues tab