Skip to content

Latest commit

 

History

History
122 lines (89 loc) · 3.32 KB

how-to.md

File metadata and controls

122 lines (89 loc) · 3.32 KB
title sidebarTitle description
Add a title (using an infinitive like this one)
Optional short title if 'title' is long
A short description (up to ~160 characters) of the article that should make sense out of context (like on a listing page).

Introduce the topic in 1 or 2 sentences. Include reasons why the reader might want to do it (the most common use cases). Also include what the goal of the task is.

Before you begin

Include here any terms the reader might need that they might not be familiar with (like terms specific to Platform.sh). Either define them here or link to a definition elsewhere in the docs.

Also include any prerequisites they might need to install/know, such as having the CLI installed or having created a project.

For tasks like installing the CLI, link to instructions rather than including them here.

1. Do this step first

This starts the list of steps readers must do in order (each step is a separate section in the document). Order the steps with numbers. The titles should be bare infinitives: https://developers.google.com/style/headings?hl=en

Introduce the purpose of this step very briefly.

Then use an ordered list for the actions to take to complete the step:

  1. Do this action first.
  2. Do this action next.
  3. Do this action third.
  4. Do this action fourth.

Include a short example of what the expected outcome of this step is, such as a code example, a description of what the user can do now, or (if absolutely necessary) a screenshot.

2. Do this step second

Split into separate steps when there are more than 5--7 actions in a step. Also when each separate step has an outcome that be described or shown.

Introduce the purpose of this step very briefly.

Use an ordered list for the actions to take. If the intended audience might be likely to do things in multiple ways, split the various ways into tabs so users only see what's relevant to them:

{{< codetabs >}}

title=Using the CLI file=none highlight=false

  1. Do this action first with the CLI.
  2. Do this action next with the CLI.
  3. Do this action third with the CLI.
  4. Do this action fourth with the CLI.

<--->

title=In the console file=none highlight=false

  1. Do this action first in the console.
  2. Do this action next in the console.
  3. Do this action third in the console.
  4. Do this action fourth in the console.

{{< /codetabs >}}

Include a short example of what the expected outcome of this step is.

3. Run these commands

The examples can include commands to run. Start by introducing the purpose of this step very briefly.

Use an ordered list for the actions to take:

  1. Run command --options.
  2. Run other_command --options.
  3. Run third_command --options.

Include a short example of what the expected outcome of this step is.

outcome:
    yaml:
      - beautiful
      - clean
      - optimized

What's next

Include an example of the expected outcome for the task as a whole. Link to any further information or other tasks they might want to do next.