Skip to main content

Documentation reports

Liberty Next → Document → Documentation reports writes the documentation of the installation as it stands — a deliverable for a project, a hand-over, an audit of the configuration — as a PDF or in Markdown. Superusers only.

At a glance​

Implementation reportSETTINGSLanguageFrançaisEnglishDate label (cover page)default: todayDownload the PDFMarkdownCONTENT9 of 11 sectionsContextArchitectureApplications and menusScreensConnectors and poolsDashboards and ExplorerOperationsSecurityReference dataAppendix: settingsAppendix: API referenceLanguageand the cover datePDF or Markdownsecrets maskedSections to tickappendices on demand

The two reports​

ReportForSections
Implementation report — technical and functional documentation of the installThe project team, the customer.Context, Architecture, Applications and menus, Screens, Connectors and pools, Dashboards and Explorer, Operations, Security, Reference data; on demand, the appendices Settings — every setting, secrets masked — and API reference.
Technical report — developer documentationThe people who maintain the install.Scope, Architecture, Data model, Configuration reference, API reference, Command line, Build and packaging, Appendix: code references.

Producing one​

  1. Open the report's card.
  2. Tick the sections — All / None —; the counter shows N of M sections. The technical report offers two options: detail every API route, and include the code snippets in the appendix — long.
  3. Under Settings, pick the Language — Français or English — and, if needed, the Date label of the cover page; by default, today.
  4. Download the PDF, or Markdown to edit it further.

Every value whose name says it is a secret — passwords, keys, tokens — is masked, and so are the connection addresses.