Wiki

Wiki

Step 2: Write your first page

In this step, Grace writes the page How we deploy in the Engineering Handbook. Her edits go into a change request, not to the live site.

Create the page

A new space has no pages. The sidebar says No pages yet, and the page area has a New page button.

The empty Engineering Handbook space, with No pages yet in the sidebar and a New page button in the page area

  1. In the sidebar, click Engineering Handbook to open the space.
  2. Click New page.
  3. In Title, type How we deploy. The Route fills in as engineering/how-we-deploy.
  4. Click Save.

The Create New Page dialog with the title How we deploy

The page opens in the editor.

In an empty space, Frappe Wiki starts a change request called Add initial content for you. In a space that has pages, you click Edit first. Then you give your change a title in the New change request dialog and click Start editing.

Write the text

Click below the title and type. For example:

We deploy from the main branch every weekday at 10:00 UTC. Each deploy goes to staging first.

You can use Markdown shortcuts as you type. For example, ## starts a heading and - starts a list.

Add a callout

  1. On a new line, type /.
  2. Under Callouts, click Warning.
  3. Type Do not deploy on Fridays.

Add an image

  1. On a new line, type / and click Image.
  2. Select an image file on your computer, for example a diagram of the deploy pipeline.

The image uploads and shows in the page. You can also click Insert Image in the toolbar.

The page How we deploy in the editor with text, a warning callout and an image

Your edits save as you type

You do not need a save button. When you stop typing for a moment, the editor saves your edits to the change request. Saving… shows at the bottom of the sidebar while it saves.

The card under the space name shows the title of the change request, its status Draft, and how many pages it changes.

The change request card in the sidebar with the title Add initial content, Draft and 1 page changed

Readers do not see the page yet. It goes live only after the change request is merged.

To learn more about the editor, see Edit a page, Callouts and Images.

Next

Step 3: Submit for review

Last updated 10 hours ago
Was this helpful?
Thanks!