coop-cloud-chaos-patchs/outline
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

changed copy

Browse Source
This commit is contained in:
Jori Lallo
2018-01-17 22:16:13 -08:00
parent a6584714c3
commit eb1ba1a6be
1 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
server/utils/onboarding.js
View File

@ -1,33 +1,31 @@
// @flow // @flow
const template = `# Welcome to Outline export const welcomeMessage = (collectionId: string) =>
`# Welcome to Outline
Outline a place for your team to build your knowledge base. This can include: Outline is a place for your team to build your knowledge base. This can include:
* Team wiki * Team wiki
* Documentation * Documentation
* Playbooks * Playbooks
* Employee onboarding * Employee onboarding
* ...or anything you can think of
...and anything you can think of. ## 🖋 A powerful editor
## 🖋 Editor to fit your needs
![Text formatting in Outline](https://s3.amazonaws.com/dev.beautifulatlas.com/uploads/e2b85962-ca66-4e4c-90d3-b32d30f0610c/754830c0-2aca-467c-82de-2fd6e990b696/Group.png) ![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 is build to be fast and extensible. You can easily format your documents with keyboard shortcuts or simply highlighting the text and making your selections. To add images, just drag and drop them to your canvas. 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.
Like many developers, we love [Markdown](http://commonmark.org/help/) and you can format your Outline documents by writing Markdown it will get formatted without the need for previews.
## 👩‍💻 Developer friendly ## 👩‍💻 Developer friendly
Outline features an [open API](https://www.getoutline.com/developers) and syntax highlighting which makes it ideal for software teams. To create your first document using the API, create an API key in [settings](https://www.getoutline.com/settings/tokens) and run the following Javascript code. Just remember to update your API key and keep it secure! 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 = { const newDocument = {
title: 'Getting started with codebase', title: 'Getting started with codebase',
text: 'All the information needed in Markdown', text: 'All the information needed in Markdown',
collection: 'COLLECTION_ID', collection: '${collectionId}',
token: 'API_KEY', // Replace with a key from https://www.getoutline.com/settings/tokens token: 'API_KEY', // Replace with a value from https://www.getoutline.com/settings/tokens
}; };
fetch('https://www.getoutline.com/api/documents.create', { fetch('https://www.getoutline.com/api/documents.create', {
@ -39,10 +37,7 @@ fetch('https://www.getoutline.com/api/documents.create', {
}); });
\`\`\` \`\`\`
## 💬 Say hi to the team ## 👋 Say hi to the team
Outline is build by a small team and we would love to get 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). Outline is build by a small team and we would love to get 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).
`; `;
export const welcomeMessage = collectionId =>
template.replace('COLLECTION_ID', collectionId);