Feature #544
openOrientation doc created in Outline
0%
Description
Activities¶
- Move sections from Word doc to Outline.
- Exactly who is this document for now? - This is a Welcome, Overview, and Index of what things a new person will use or encounter while working for/with Sandwich and where the documentation about each of them can be found.
- Finish write-ups for Zammad and VitXi.
- Create write-ups for Outline, Nextcloud.
- Shunt all the detailed "How to do" docs into a different section in Outline.
- Schedule quarterly document review.
James does not like current practice on wikis in that there is no taxonomy, no welcome and orientation (this is a pet peeve of Trisha's, too).
Not every tool needs a step-by-step instruction on how to do things with illustrations. The ones that have the weakest documentation are: VitXi, Blesta. The ones that have adequate documentation are Zammad, Outline, and Nextcloud.
James will handle all the crunchy engineering docs for these systems.
Walrus Blocks¶
Outline (please complete the following information):
- Install: getoutline.com - What do I put here? Self-hosted?
Desktop (please complete the following information):
- OS: Edition Windows 11 Home Version 24H2 Installed on 2024-11-17 OS build 26100.3323 Experience Windows Feature Experience Pack 1000.26100.54.0
- Browser Firefox
- Version 136.0 (64-bit)
Outline Stuff¶
Borders around images - Is there a way in Outline how to do this? If not, this is a feature request and I should ask about it in Discussions on GitHub.
Bugs to Report and Discussions to Have on GitHub¶
Where did the ability to edit captions go?
Start editing bug in New Document - GitHub, Outline
After publishing, admin cannot see new document - GitHub, Online
Customizable border formatting on tables - Feature request
Captions for tables - Feature request
Does this work better in Chrome? Test this tomorrow
Is there a way to turn off automatic listing? - Discussions item which could possibly be a "how do I do this"; put it in Feature requests
Download as HTML, where's the beef? - This is a bug
How does the link look when it's published and we share the link - This is for us to experiment about
What is best practice for wall of text with screenshots versus short text with links to the walls of text with screenshots? - This is for us to determine
How do your organize Collections into internal versus external
Style Guide Questions and Notes¶
What are the default sizes for images: wide, single, side-by-side?
How thick do we want the border around images and what colour should they be?
HTML notation colour for Sandwich logo: 5f9ea0
Internal collection items are marked with a sandwich emoji
External collection items are marked with a globe icon