feat: Improved onboarding documents (#970)
* feat: New onboarding documents * Images -> blocks * Add tips * test: removes assumptions of welcome documents this actually results in the tests being much more understandable too * add db flag when document was created from welcome flow
This commit is contained in:
17
server/onboarding/editor.md
Normal file
17
server/onboarding/editor.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# 📝 Our Editor
|
||||
|
||||
The heart of Outline is the document editor. We let you write in the way that you prefer – be it Markdown, WYSIWYG, or taking advantage of the many keyboard shortcuts.
|
||||
|
||||

|
||||
|
||||
## Markdown
|
||||
|
||||
If you’re comfortable writing markdown then all of the usual shortcuts are supported, for example type \*\*bold\*\* and hit `space` to instantly create bold text. If you forget some syntax or are after a refresher, simply type `?` to access the keyboard shortcut help.
|
||||
|
||||
*Tip:* You can even paste markdown from elsewhere directly into a document.
|
||||
|
||||
## Blocks
|
||||
|
||||
The editor supports a variety of content blocks including images, tables, lists, quotes, and more. You can also drag and drop images to include them in your document or paste a link to embed content from one of the many supported [integrations](/integrations)
|
||||
|
||||
*Tip:* Headings are collapsible, just click the arrow to the left of any heading to temporarily hide the content below.
|
||||
28
server/onboarding/integrations.md
Normal file
28
server/onboarding/integrations.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# 🚀 Integrations & API
|
||||
|
||||
## Integrations
|
||||
|
||||
Outline supports tons of the most popular tools on the market out of the box. Just paste links to a YouTube video, Figma design, or Realtimeboard to get instant live-embeds in your documents.
|
||||
|
||||
Our integration code is [open-source](https://github.com/outline/outline) and we encourage third party developers and the community to build support for additional tools! Find out more on our [integrations directory](https://www.getoutline.com/integrations).
|
||||
|
||||
*Tip:* Most integrations work by simply pasting a link from a supported service into a document.
|
||||
|
||||
## Slack
|
||||
|
||||
If your team is using Slack to communicate then you’ll definitely want to enable our [Slack App](https://getoutline.slack.com/apps/A0W3UMKBQ-outline) to get instant link unfurling for Outline documents and access to the `/outline` slash command to search your knowledgebase from within Slack.
|
||||
|
||||
## API
|
||||
|
||||
Have some technical skills? Outline is built on a fully featured RPC-style [API](https://www.getoutline.com/developers). Create (or even append to) documents, collections, provision users, and more programmatically. All documents are edited and stored in markdown format – try out this CURL request!
|
||||
|
||||
```bash
|
||||
curl -XPOST -H "Content-type: application/json" -d '{
|
||||
"title": "My first document",
|
||||
"text": "# My first document \n Hello from the API 👋",
|
||||
"collectionId": "COLLECTION_ID", // find the collection id in the URL bar
|
||||
"token": "API_TOKEN", // get an API token from https://www.getoutline.com/settings/tokens
|
||||
"publish": true
|
||||
}' 'https://www.getoutline.com/api/documents.create'
|
||||
```
|
||||
|
||||
19
server/onboarding/philosophy.md
Normal file
19
server/onboarding/philosophy.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# 👋 What is Outline
|
||||
|
||||
Outline is a place to build your team knowledge base, you could think of it like your team’s shared library – a place for important documentation, notes, and ideas to live and be discovered. Some things you might want to keep in Outline:
|
||||
|
||||
- Documentation
|
||||
- Sales playbooks
|
||||
- Support scripts
|
||||
- Onboarding
|
||||
- HR documents
|
||||
- Meeting notes
|
||||
- …and more
|
||||
|
||||
## Structure
|
||||
|
||||
Outline allows you to organize documents in "collections", for example these could represent topics like Sales, Product, or HR. Within collections documents can be interlinked and deeply nested to easily build relationships within your knowledgebase.
|
||||
|
||||
## Search
|
||||
|
||||
Outline is built to be crazy fast, and that includes [search](/search). You can start searching from anywhere with the `CMD+K` shortcut. Then filter by time, author, and more to get to the info you need.
|
||||
9
server/onboarding/support.md
Normal file
9
server/onboarding/support.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# ❤️ Support
|
||||
|
||||
We hate bugs as much as you and do everything possible to keep the app bug-free. Help us out by getting in touch with the team if you see any problems with Outline. You can email [hello@getoutline.com](hello@getoutline.com) directly and we’ll get back to you (hopefully with a fix!) as soon as possible.
|
||||
|
||||
If you already have a GitHub account then you can also submit issues directly to the development team on our [open issue tracker](https://github.com/outline/outline/issues).
|
||||
|
||||
## Ideas
|
||||
|
||||
We’d love to hear your ideas about how Outline can be improved and features you would like to see built. The best place to let the team know is through our [Spectrum community](https://spectrum.chat/outline).
|
||||
Reference in New Issue
Block a user