Skip to main content

Troubleshooting

Guide to resolving common problems with the Operations Guide

RuntimeError

Issue: RuntimeError often occurs when images and binary files are not properly organised

Operations Tabs

Solution: - Ensure all images are stored in an images subfolder - Place all binary files in appropriate subfolders (e.g., bins, assets)

Webpage Rendering Errors

Issue: Incorrect file extension can lead to webpage rendering errors

Operations Tabs

Solution:

  • The file name is missing html from its extension
  • Use the correct file extension, example: pagename.html.md.erb`
  • Common mistake: pagename.md.erb` (missing ‘html’)
Incorrect: pagename.md.erb
vs
correct: pagename.html.md.erb

Escape a special character

Issue: Special characters can cause unexpected behavior in Markdown rendering

Solution:

  • Add a backslash \ before the special character to escape it
Escaped underscore: \_
Escaped backtick: \`

Grouped Index Headings

Issue: Multiple headings are shown in the index but only a single page is displayed when selected

Operations Tabs

Solution:

  • Escape special characters in code sections using backslashes
  • Review your Markdown syntax for any unintended formatting
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.