Documentation articles tracking

[minijackson]

This issues references all articles that we're planning on adding to the Phoebus Olog documentation, as discussed during the 2026 Diamond Codeathon.

Operator role

Anyone creating/updating log entries, or anyone searching for and reading log entries

• Tutorials

  • First concepts / how to create a log entry (tutorial) #261

• Guides

  • CommonMark CheatSheet -> To be migrated from HTML to Markdown
    • New documentation structure #252
  • Search Query syntax -> To be migrated from HTML to Markdown
    • New documentation structure #252
  • How to update a log entry

• Explanations

  • The structure of a log entry

System Administrator role

Deploy and configure the services, defines the tags/properties, monitoring the health of the services

• Guides

  • How to deploy and configure (both systemd and Docker?)
    • Sysadmin guides, migrate guides from the README #253
    • Mention websockets and reverse proxies
  • How to set up authentication (LDAP / AD)
  • How to configure clients (links to Phoebus / Olog web documentation)
  • How to add tags / logbooks / properties / templates

• References

  • Configuration reference
    • First version in Sysadmin guides, migrate guides from the README #253

Developer

Uses Olog REST API for client development

• Guides

  • How to upload a log entry
    • And with attachments
  • How to authenticate to the API

• References

  • HTTP API Reference
  • Websocket API

Contributor role

Who contributes code

• Guides

  • How to compile
    • Sysadmin guides, migrate guides from the README #253

• Explanations

  • Code hygiene

• References

  • Javadoc