This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
outline/server/utils/onboarding.js
Tom Moor 07a941a65d Websocket Support (#937)
* Atom / RSS meta link

* Spike

* Feeling good about this spike now

* Remove document.collection

* Remove koa.ctx from all presenters to make them portable outside requests

* Remove full serialized model from events
Move events.add to controllers for now, will eventually be in commands

* collections.create event
parentDocument -> parentDocumentId

* Fix up deprecated tests

* Fixed: Doc creation

* documents.move

* Handle collection deleted

* 💚

* Authorize room join requests

* Move starred data structure
Account for documents with no context on sockets

* Add socket.io-redis

* Add WEBSOCKETS_ENABLED env variable to disable websockets entirely for self hosted
New installations will default to true, existing installations to false

* 💚 No need for promise response here

* Reload notice
2019-04-17 19:11:23 -07:00

44 lines
1.6 KiB
JavaScript

// @flow
export const welcomeMessage = (collectionId: string) =>
`# Welcome to Outline
Outline is a place for your team to build your knowledge base. This can include:
* Team wiki
* Documentation
* Playbooks
* Employee onboarding
* ...or anything you can think of
## 🖋 A powerful editor
![Text formatting in Outline](https://s3.amazonaws.com/dev.beautifulatlas.com/uploads/e2b85962-ca66-4e4c-90d3-b32d30f0610c/754830c0-2aca-467c-82de-2fd6e990b696/Group.png)
Outline's editor lets you easily format your documents with keyboard shortcuts, Markdown syntax or by simply highlighting the text and making your selections. To add images, just drag and drop them to your canvas.
## 👩‍💻 Developer friendly
Outline features an [API](https://www.getoutline.com/developers) for programatic document creation. To create your first document using the API, simply write it in Markdown and make a call to add it into your collection:
\`\`\`
const newDocument = {
title: 'Getting started with codebase',
text: 'All the information needed in Markdown',
collectionId: '${collectionId}',
token: 'API_KEY', // Replace with a value from https://www.getoutline.com/settings/tokens
};
fetch('https://www.getoutline.com/api/documents.create', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(newDocument),
});
\`\`\`
## 👋 Say hi to the team
Outline is built by a small team and we would love to get to know our users. Drop by at [our Spectrum community](https://spectrum.chat/outline) or [drop us an email](mailto:hello@getoutline.com).
`;