Edit This Page

Writing a New Topic

This page shows how to create a new topic for the GeoidApp docs.

• Before you begin
• Choosing a page type
• Choosing a title and filename
• Creating an entry in the table of contents
• What’s next

Before you begin

Create a fork of the GeoidApp documentation repository as described in Creating a Documentation Pull Request.

Choosing a page type

As you prepare to write a new topic, think about which of these page types is the best fit for your content:

Tutorial

A tutorial page shows how to accomplish a goal that is larger than a single task. Typically a tutorial page has several sections, each of which has a sequence of steps. For example, a tutorial might provide a walkthrough of a code sample that illustrates a certain feature of GeoidApp. Tutorials can include surface-level explanations, but should link to related concept topics for deep explanations.

Each page type has a template that you can use as you write your topic. Using templates helps ensure consistency among topics of a given type.

Choosing a title and filename

Choose a title that has the keywords you want search engines to find. Create a filename that uses the words in your title separated by hyphens. For example, the topic with title Using an HTTP Proxy to Access the GeoidApp API has filename http-proxy-access-api.md. You don’t need to put “GeoidApp” in the filename, because “GeoidApp” is already in the URL for the topic, for example:

You can put your file in an existing subdirectory, or you can create a new subdirectory.

Creating an entry in the table of contents

Depending page type, create an entry in one of these files:

• /_data/tasks.yaml
• /_data/tutorials.yaml
• /_data/concepts.yaml

What’s next

• Learn about using page templates.
• Learn about staging your changes.
• Learn about creating a pull request.