Edit This Page

Creating a Documentation Pull Request

To contribute to the GeoidApp documentation, create a pull request against the geoidapp/geoidapp.github.io repository. This page shows how to create a pull request.

• Before you begin
• Creating a fork of the GeoidApp documentation repository
• Making your changes
• Submitting a pull request to the master branch
• Submitting a pull request to the <vnext> branch
• What’s next

Before you begin

1. Create a GitHub account.

Creating a fork of the GeoidApp documentation repository

1. Go to the geoidapp/geoidapp.github.io repository.

2. In the upper-right corner, click Fork. This creates a copy of the GeoidApp documentation repository in your GitHub account. The copy is called a fork.

Making your changes

1. In your GitHub account, in your fork of the GeoidApp docs, create a new branch to use for your contribution.

2. In your new branch, make your changes and commit them. If you want to write a new topic, choose the page type that is the best fit for your content.

Submitting a pull request to the master branch

If you want your change to be published in the released version GeoidApp docs, create a pull request against the master branch of the GeoidApp documentation repository.

1. In your GitHub account, in your new branch, create a pull request against the master branch of the GeoidApp/GeoidApp.github.io repository. This opens a page that shows the status of your pull request.

2. Click Show all checks. Wait for the deploy/netlify check to complete. To the right of deploy/netlify, click Details. This opens a staging site where you can verify that your changes have rendered correctly.

3. During the next few days, check your pull request for reviewer comments. If needed, revise your pull request by committing changes to your new branch in your fork.

Submitting a pull request to the <vnext> branch

What’s next

• Learn about writing a new topic.
• Learn about using page templates.
• Learn about staging your changes.