chore: Improved onboarding docs
This commit is contained in:
Tom Moor
@ -1,6 +1,8 @@
|
||||
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](mailto:hello@getoutline.com) directly and we’ll get back to you (hopefully with a fix!) as soon as possible.
|
||||
We hate bugs as much as you and do everything possible to keep the application bug-free and performant. If you see any problems with Outline please get in touch with the team – you can email [hello@getoutline.com](mailto: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).
|
||||
## GitHub
|
||||
|
||||
If you 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
|
||||
|
||||
|
||||
@ -14,4 +14,4 @@ Outline allows you to organize documents in "collections", for example these cou
|
||||
|
||||
## 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.
|
||||
Outline is built from the ground up to be really 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 find the information you need. Or you can search from within Slack with the `/outline` slash command.
|
||||
@ -1,4 +1,4 @@
|
||||
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.
|
||||
The heart of Outline is the document editor. We let you write in whichever way you prefer – be it Markdown, WYSIWYG, or taking advantage of the many keyboard shortcuts.
|
||||
|
||||
|
||||
|
||||
@ -13,3 +13,7 @@ If you’re comfortable writing markdown then all of the usual shortcuts are sup
|
||||
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](https://www.getoutline.com/integrations)
|
||||
|
||||
*Tip:* Headings are collapsible, just click the arrow to the left of any heading to temporarily hide the content below.
|
||||
|
||||
## References
|
||||
|
||||
Linking to another document automatically creates backlinks which are kept up-to-date and shown at the bottom of the document, so you can create a library of linked information and easily answer the question "which other documents link here?".
|
||||
@ -1,23 +1,23 @@
|
||||
## 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.
|
||||
Outline supports many of the most popular tools on the market without any additional settings or configuration. Just paste links to a YouTube video, Figma file, or Google Spreadsheet to get instant live-embeds in your documents. Take a look at the [integrations directory](https://www.getoutline.com/integrations) for a list of all of the tools that are supported.
|
||||
|
||||
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).
|
||||
Our integration code is also [open-source](https://github.com/outline/outline) and we encourage third party developers and the community to build support for additional tools!
|
||||
|
||||
*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.
|
||||
If your team is using Slack to communicate then you’ll definitely want to enable our [Slack Integration](/settings/integrations/slack) to get instant link unfurling for Outline documents and access to the `/outline` slash command to search your knowledgebase directly from 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!
|
||||
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 example CURL request to get started:
|
||||
|
||||
```bash
|
||||
curl -XPOST -H "Content-type: application/json" -d '{
|
||||
"title": "My first document",
|
||||
"text": "# My first document \n Hello from the API 👋",
|
||||
"text": "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
|
||||
|
||||
Reference in New Issue
Block a user