diff --git a/server/models/Team.js b/server/models/Team.js index 12929ebb..887b998a 100644 --- a/server/models/Team.js +++ b/server/models/Team.js @@ -170,9 +170,9 @@ Team.prototype.provisionFirstCollection = async function (userId) { // For the first collection we go ahead and create some intitial documents to get // the team started. You can edit these in /server/onboarding/x.md const onboardingDocs = [ - "Support", "Integrations & API", "Our Editor", + "Getting Started", "What is Outline", ]; diff --git a/server/onboarding/Getting Started.md b/server/onboarding/Getting Started.md new file mode 100644 index 00000000..5e55f8a1 --- /dev/null +++ b/server/onboarding/Getting Started.md @@ -0,0 +1,21 @@ +# Getting Started + +Some ideas to get you and your team started with learning the basics of Outline, feel free to check them off as you go! + +## Learn the basics + +- [x] Create an Outline account +- [ ] **Create a collection** from the left sidebar +- [ ] **Create a new doc** from the top right of home or any collection +- [ ] Try drag and drop to nest and move documents +- [ ] Share a document +- [ ] Invite a co-worker 👋 + +## More to try + +- [ ] Setup the [Slack integration](/settings/integrations/slack) +- [ ] **Create a template** to share a writing structure with your team +- [ ] Create a check list to track tasks +- [ ] Try embedding a supported [integration](https://www.getoutline.com/integrations) + + diff --git a/server/onboarding/Our Editor.md b/server/onboarding/Our Editor.md index f397b9a1..ca85b681 100644 --- a/server/onboarding/Our Editor.md +++ b/server/onboarding/Our Editor.md @@ -1,24 +1,17 @@ -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. +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 (Type `?` to see them all). ## Markdown -If you’re comfortable writing markdown then all of the shortcuts you are used to are supported, for example type \*\*bold\*\* to instantly create bold text. If you forget some syntax or are after a quick refresher hit the keyboard icon in the bottom right hand corner for our guide. Learning some of the key Markdown shortcuts will make using Outline faster and more enjoyable! - -![The formatting toolbar](/images/screenshots/formatting-toolbar.png) +If you’re comfortable writing markdown then all of the shortcuts you are used to are supported, for example type \*\*bold\*\* to instantly create **bold** text. If you forget some syntax or are after a quick refresher hit the keyboard icon in the bottom right hand corner for our guide. Learning some of the key Markdown shortcuts will definitely make using Outline faster and more enjoyable! :::info -You can also paste markdown or html from elsewhere directly into a document. +You can also paste markdown, html, or rich text from elsewhere directly into a document. ::: - -## Rich documents - -The editor supports a variety of content blocks including images, tables, lists, quotes, videos, and more. Type "/" on an empty line or click on the "+" icon to trigger the block insert menu, you can keep typing to filter it down. - -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) - -![The block menu](/images/screenshots/block-menu.png) - ## 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?". \ No newline at end of file +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?". + +## Rich documents + +The editor supports a variety of content blocks including images, tables, lists, quotes, task lists, videos, and more. Type `/` on an empty line or click on the `+` icon to trigger the block insert menu, you can keep typing to filter it down. Of course, 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) diff --git a/server/onboarding/Support.md b/server/onboarding/Support.md deleted file mode 100644 index b6870bb7..00000000 --- a/server/onboarding/Support.md +++ /dev/null @@ -1,9 +0,0 @@ -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. - -## GitHub - -If you have a GitHub account then you can also submit bugs directly to the development team on our public [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 [GitHub discussions](https://github.com/outline/outline/discussions). diff --git a/server/onboarding/What is Outline.md b/server/onboarding/What is Outline.md index 0ae021b4..5030ad08 100644 --- a/server/onboarding/What is Outline.md +++ b/server/onboarding/What is Outline.md @@ -1,16 +1,16 @@ -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: +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 include: - Documentation +- Support knowledge base +- Product plans and RFCs - Sales playbooks -- Support scripts -- Onboarding -- HR documents +- Onboarding checklists +- Company policies - 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 knowledge base. +Outline allows you to organize documents in "collections", for example these could represent topics like Sales, Product, or HR. You can assign users or groups access to collections. Within collections documents can be interlinked and deeply nested to easily build relationships within your knowledge base. ## Search