Draft outline for Discourse recording
Finding an Existing Document
How to search for a document :mvp:
explain discourse search bar
show how to use it
show the results
Understanding slugs, topics, and raw :mvp:
show the discourse address bar
highlight the slug and topic
show how the topic overrides
show how the slug will find it without topic
show how to get the raw markdown
Editing an Existing Document
Opening a document in editing mode :mvp:
search for a document
show how to open the doc for editing (top pencil)
show the side-by-side editing screens
show how to maximize the side-by-side screens
mention that the screens don’t track perfectly, so you may need to adjust
show someone adding text to the document
show using each of the toolbar buttons in turn
Editing the content of a document :mvp:
show the admonition block
<make a list of other non-toolbar-ed edit sequence
Saving changes :mvp:
show how to save the document
show how to cancel a save
demonstrate how to copy for pasting, if don’t want to save but don’t want to hold it open, either
show how to handle a deadlock (copy for pasting, cancel, try again later)
Reverting to a previous version
how to get to side-by-side versions
how to compare side-by-side versions
things that don’t always show up in side-by-side mode
how to revert versions
what happens to the version you just reverted from?
Creating a New Document
Starting a new document :mvp:
how to start a new document
how to title the document
how to set the right category
tags are up to the discourse owner/product team
Capturing the topic number :mvp:
how to capture the topic number
how/why to keep a separate list or backup set
Deleting a Document
how to mark document as deleted
what happens to a deleted document?
how do you undelete a document?
Promoting Discourse Pages into Official Documents
Adding a document to the navigation menu :mvp:
where the navigation menu is kept
how to access the navigation menu
components of the navigation menu
how levels work in the navigation menu
a word about navigation menu hygiene
Adding a redirect to the document structure
slugs and the documentation URL
the redirect table
the components of the redirect table
adding a redirect
adjusting secondary redirects
Managing caching issues
if your work shows up in discourse, but not in docs
find out you caching situation
negotiate your caching situation
