Write and publish docs

For engineers 4 min read

Write Markdown in ELOS with a live preview and lint, then publish it so it's searchable and Ask ELOS can cite it.

Docs is where engineers write runbooks, guides and decision records in Markdown. Published docs join your organization's knowledge, so search finds them and Ask ELOS can answer from them.

Write a doc

1. Open Docs and choose New doc.
2. Give it a title and write in Markdown. The Preview updates as you type.
3. Check the lint result under the editor, for example Markdown looks clean — renders correctly.
4. Choose Save draft to keep working on it, or Publish to make it searchable and available to Ask ELOS.

Who can see a doc

A draft is visible to the person who wrote it and to everyone who can author docs, so authors can review each other's work. A published doc is visible to everyone in the workspace. A doc linked to a service is visible only to people whose role can see that service, whether it's a draft or published. Each published doc has its own page, and that's where search results and Ask ELOS citations take you.

If someone else saved first

When a teammate saves a doc after you opened it, ELOS doesn't overwrite their changes. It tells you who saved and offers Reload latest. Copy your text first if you want to keep it.

Unpublish or archive

Unpublish turns a doc back into a draft. Archive hides it from readers. Either way it leaves your organization's knowledge, so search and Ask ELOS stop using it. Both are recorded in the audit log.

Bring in existing docs

Choose Import to bring in one or more Markdown files. Each shows a preview and lint result, and is imported as a draft. Front matter such as title and tags is kept.

Use a doc elsewhere

Copy for Confluence / wiki copies the doc in a form you can paste into your wiki, so ELOS doesn't become another place you have to keep in sync.