Skip to main content

Adding Pages

These pages are written in the Markdown, lightweight markup language and stored with a github repo.

Prerequisites

  • Basic knowledge of using markdown to create documents
  • Access to the repo hmcts/ops-runbooks

Documentation

Initially, documents should be created in OneNote, Word, or other feature rich editor, to enable the information to be captured. Once the document is ready, save each page as a file within the folder using the extension .html.md.erb

Index Page

The first page in every folder should be called index.html.md.erb and start with these 7 lines of code.

---
title: Contribution Guide
weight: 5
---

# <%= current_page.data.title %>

Weight is used to control the pages position in the master index. With low numbers at the top. Where possible increment the count by 10.

Well Written Pages

  • Prerequisite Section at top
  • Diagrams (A good diagram, tells the story)
  • Admin Tools
    • Admin portal (URL or IP address)
    • Instructions to download, install and configure
    • Describe with text, how to navigate within the system
  • Follow house style guide
    • Use empty template for new products and applications
    • When section is empty, leave it in place but add the word blank to show it is not relevant
  • Core sections
    • Introduction or Description (What is it)
    • Prerequisites (Can it be made to work by reader)
    • Location (Links, URLs, IP addresses or pointers)
This page was last reviewed on 26 January 2024. It needs to be reviewed again on 26 January 2025 by the page owner platops-build-notices .
This page was set to be reviewed before 26 January 2025 by the page owner platops-build-notices. This might mean the content is out of date.