Skip to content

Commit

Permalink
Renamed Atlas to Outline
Browse files Browse the repository at this point in the history
  • Loading branch information
jorilallo committed Nov 9, 2017
1 parent 12d2061 commit f5c51a9
Show file tree
Hide file tree
Showing 20 changed files with 47 additions and 47 deletions.
4 changes: 2 additions & 2 deletions .env.sample
Expand Up @@ -2,8 +2,8 @@
#
# Please use `openssl rand -hex 32` to create SEQUELIZE_SECRET

DATABASE_URL=postgres://user:pass@example.com:5432/atlas
DATABASE_URL_TEST=postgres://user:pass@example.com:5432/atlas-test
DATABASE_URL=postgres://user:pass@example.com:5432/outline
DATABASE_URL_TEST=postgres://user:pass@example.com:5432/outline-test
PORT=3000
REDIS_URL=redis://localhost:6379
SEQUELIZE_SECRET=F0E5AD933D7F6FD8F4DBB3E038C501C052DC0593C686D21ACB30AE205D2F634B
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2017 Atlas (https://www.beautifulatlas.com/) and individual contributors.
Copyright (c) 2017 Outline (https://www.getoutline.com/) and individual contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Expand All @@ -8,7 +8,7 @@ Redistribution and use in source and binary forms, with or without modification,
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of the Atlas nor the names of its contributors may be used to endorse or promote products derived from this software
3. Neither the name of the Outline nor the names of its contributors may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
Expand Down
2 changes: 1 addition & 1 deletion app.json
@@ -1,5 +1,5 @@
{
"name": "atlas",
"name": "outline",
"scripts": {
"postdeploy": "yarn build && yarn sequelize:migrate"
},
Expand Down
8 changes: 4 additions & 4 deletions app/components/Editor/components/Link.js
Expand Up @@ -14,13 +14,13 @@ function getPathFromUrl(href: string) {
}
}

function isAtlasUrl(href: string) {
function isOutlineUrl(href: string) {
if (href[0] === '/') return true;

try {
const atlas = new URL(BASE_URL);
const outline = new URL(BASE_URL);
const parsed = new URL(href);
return parsed.hostname === atlas.hostname;
return parsed.hostname === outline.hostname;
} catch (err) {
return false;
}
Expand All @@ -30,7 +30,7 @@ export default function Link({ attributes, node, children, readOnly }: Props) {
const href = node.data.get('href');
const path = getPathFromUrl(href);

if (isAtlasUrl(href) && readOnly) {
if (isOutlineUrl(href) && readOnly) {
return <InternalLink {...attributes} to={path}>{children}</InternalLink>;
} else {
return <a {...attributes} href={href} target="_blank">{children}</a>;
Expand Down
2 changes: 1 addition & 1 deletion app/components/Layout/Layout.js
Expand Up @@ -102,7 +102,7 @@ type Props = {
return (
<Container column auto>
<Helmet>
<title>Atlas</title>
<title>Outline</title>
<meta
name="viewport"
content="width=device-width, initial-scale=1.0"
Expand Down
2 changes: 1 addition & 1 deletion app/components/PageTitle/PageTitle.js
Expand Up @@ -7,7 +7,7 @@ type Props = {
};

const PageTitle = ({ title }: Props) => (
<Helmet><title>{`${title} - Atlas`}</title></Helmet>
<Helmet><title>{`${title} - Outline`}</title></Helmet>
);

export default PageTitle;
2 changes: 1 addition & 1 deletion app/scenes/CollectionNew/CollectionNew.js
Expand Up @@ -56,7 +56,7 @@ type Props = {
return (
<form onSubmit={this.handleSubmit}>
<HelpText>
Collections are for grouping your Atlas. They work best when organized
Collections are for grouping your Outline. They work best when organized
around a topic or internal team — Product or Engineering for example.
</HelpText>
<Input
Expand Down
2 changes: 1 addition & 1 deletion app/scenes/KeyboardShortcuts/KeyboardShortcuts.js
Expand Up @@ -9,7 +9,7 @@ function KeyboardShortcuts() {
return (
<Flex column>
<HelpText>
Atlas is designed to be super fast and easy to use.
Outline is designed to be super fast and easy to use.
All of your usual keyboard shortcuts work here, and there
{"'"}
s Markdown too.
Expand Down
6 changes: 3 additions & 3 deletions app/scenes/Settings/Settings.js
Expand Up @@ -31,8 +31,8 @@ import SlackAuthLink from 'components/SlackAuthLink';
<Section>
<SectionLabel>Slack</SectionLabel>
<HelpText>
Connect Atlas to your Slack to instantly search for your documents
using <Code>/atlas</Code> command.
Connect Outline to your Slack to instantly search for your documents
using <Code>/outline</Code> command.
</HelpText>

<SlackAuthLink
Expand All @@ -52,7 +52,7 @@ import SlackAuthLink from 'components/SlackAuthLink';
<Section>
<SectionLabel>API Access</SectionLabel>
<HelpText>
Create API tokens to hack on your Atlas.
Create API tokens to hack on your Outline.
Learn more in <Link to="/developers">API documentation</Link>.
</HelpText>

Expand Down
36 changes: 18 additions & 18 deletions app/static/flatpages/api.md
@@ -1,25 +1,25 @@
# Atlas API
# Outline API

_Our API is currently in beta and we might make minor adjustments._

## Making requests

Atlas' API follows JSON RPC style conventions where each API endpoint is a method on `https://www.beautifulatlas.com/api/<METHOD>`. Each request needs to be made using HTTPS and both `GET` and `POST` (recommended) methods are supported.
Outline's API follows JSON RPC style conventions where each API endpoint is a method on `https://www.getoutline.com/api/<METHOD>`. Each request needs to be made using HTTPS and both `GET` and `POST` (recommended) methods are supported.

For `GET` requests query string parameters are expected (e.g. `/api/document.info?id=...&token=...`). When making `POST` requests, request parameters are parsed depending on `Content-Type` header. To make a call using JSON payload, one must pass `Content-Type: application/json` header:

```shell
curl 'https://www.beautifulatlas.com/api/documents.info?id=atlas-api-NTpezNwhUP'\
curl 'https://www.getoutline.com/api/documents.info?id=outline-api-NTpezNwhUP'\
-H 'authorization: Bearer <API KEY>'\
-H 'content-type: application/json'\
-H 'accept: application/json'
```

## Authentication

To access private API endpoints, you must provide a valid API key. You can create new API keys in your [account settings](https://www.beautifulatlas.com/settings). Be careful when handling your keys as they give access to all of your documents.
To access private API endpoints, you must provide a valid API key. You can create new API keys in your [account settings](https://www.getoutline.com/settings). Be careful when handling your keys as they give access to all of your documents.

To authenticate with Atlas API, you can supply the API key as a header (`Authorization: Bearer <API KEY>`) or as part of the payload using `token` parameter.
To authenticate with Outline API, you can supply the API key as a header (`Authorization: Bearer <API KEY>`) or as part of the payload using `token` parameter.

Some API endpoints allow unauhenticated requests for public resources and they can be called without an API key.

Expand All @@ -42,7 +42,7 @@ This method returns the information for currently logged in user.

#### Arguments

`https://www.beautifulatlas.com/api/user.info`
`https://www.getoutline.com/api/user.info`

Parameter | Description
------------ | -------------
Expand All @@ -52,11 +52,11 @@ Parameter | Description

### `user.s3Upload` - Gets S3 upload credentials

You can upload small files and images as part of your documents. All files are stored using Amazon S3. Instead of uploading files to Atlas, you need to upload them directly to S3 with special credentials which can be obtained through this endpoint.
You can upload small files and images as part of your documents. All files are stored using Amazon S3. Instead of uploading files to Outline, you need to upload them directly to S3 with special credentials which can be obtained through this endpoint.

#### Arguments

`https://www.beautifulatlas.com/api/user.s3Upload`
`https://www.getoutline.com/api/user.s3Upload`

Parameter | Description
------------ | -------------
Expand All @@ -73,7 +73,7 @@ List all your document collections.

#### Arguments

`https://www.beautifulatlas.com/api/collections.list`
`https://www.getoutline.com/api/collections.list`

Parameter | Description
------------ | -------------
Expand All @@ -89,7 +89,7 @@ Returns detailed information on a document collection.

#### Arguments

`https://www.beautifulatlas.com/api/collections.info`
`https://www.getoutline.com/api/collections.info`

Parameter | Description
------------ | -------------
Expand All @@ -100,14 +100,14 @@ Parameter | Description

### `collections.create` - Create a document collection

Creates a new document collection. Atlas supports two types of collections:
Creates a new document collection. Outline supports two types of collections:

- `atlas` - Structured collection with a navigation tree
- `journal` - Chronological collection of documents

#### Arguments

`https://www.beautifulatlas.com/api/collections.create`
`https://www.getoutline.com/api/collections.create`

Parameter | Description
------------ | -------------
Expand All @@ -124,7 +124,7 @@ Collection navigation can be re-organized by sending a modified version of the n

#### Arguments

`https://www.beautifulatlas.com/api/collections.updateNavigationTree`
`https://www.getoutline.com/api/collections.updateNavigationTree`

Parameter | Description
------------ | -------------
Expand All @@ -139,11 +139,11 @@ Parameter | Description
This method returns information for a document with a specific ID. Following identifiers are allowed:

- UUID - `id` field of the document
- URI identifier - Human readable identifier used in Atlas URLs (e.g. `atlas-api-i48ZEZc5zjXndcP`)
- URI identifier - Human readable identifier used in Outline URLs (e.g. `outline-api-i48ZEZc5zjXndcP`)

#### Arguments

`https://www.beautifulatlas.com/api/documents.info`
`https://www.getoutline.com/api/documents.info`

Parameter | Description
------------ | -------------
Expand All @@ -158,7 +158,7 @@ This methods allows you to search all of your documents with keywords.

#### Arguments

`https://www.beautifulatlas.com/api/documents.search`
`https://www.getoutline.com/api/documents.search`

Parameter | Description
------------ | -------------
Expand All @@ -173,7 +173,7 @@ This method allows you to publish a new document under an existing collection. I

#### Arguments

`https://www.beautifulatlas.com/api/documents.create`
`https://www.getoutline.com/api/documents.create`

Parameter | Description
------------ | -------------
Expand All @@ -191,7 +191,7 @@ Delete a document and all of its child documents if any.

#### Arguments

`https://www.beautifulatlas.com/api/documents.delete`
`https://www.getoutline.com/api/documents.delete`

Parameter | Description
------------ | -------------
Expand Down
2 changes: 1 addition & 1 deletion app/utils/ApiClient.js
Expand Up @@ -13,7 +13,7 @@ class ApiClient {

constructor(options: Options = {}) {
this.baseUrl = options.baseUrl || '/api';
this.userAgent = 'AtlasFrontend';
this.userAgent = 'OutlineFrontend';
}

fetch = (
Expand Down
4 changes: 2 additions & 2 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "Atlas",
"name": "Outline",
"private": true,
"main": "index.js",
"scripts": {
Expand Down Expand Up @@ -45,7 +45,7 @@
},
"repository": {
"type": "git",
"url": "git+ssh://git@github.com/jorilallo/atlas.git"
"url": "git+ssh://git@github.com/outline/outline.git"
},
"dependencies": {
"@tommoor/slate-drop-or-paste-images": "0.5.1",
Expand Down
2 changes: 1 addition & 1 deletion server/middlewares/subdomainRedirect.js
@@ -1,6 +1,6 @@
export default function subdomainRedirect(options) {
return async function subdomainRedirectMiddleware(ctx, next) {
if (ctx.headers.host === 'beautifulatlas.com') {
if (ctx.headers.host === 'getoutline.com') {
ctx.redirect(`https://www.${ctx.headers.host}${ctx.path}`);
} else {
return next();
Expand Down
2 changes: 1 addition & 1 deletion server/pages/About.js
Expand Up @@ -11,7 +11,7 @@ export default function About() {
<title>About</title>
</Helmet>
<Hero>
<h1>About Atlas</h1>
<h1>About Outline</h1>
<p>
Just a proof of concept for multiple pages.
</p>
Expand Down
2 changes: 1 addition & 1 deletion server/pages/Pricing.js
Expand Up @@ -13,7 +13,7 @@ export default function Pricing() {
<Hero>
<h1>Pricing</h1>
<p>
Explore Atlas with a 14 day trial, free forever for teams smaller than 5.
Explore Outline with a 14 day trial, free forever for teams smaller than 5.
</p>
</Hero>
</Grid>
Expand Down
2 changes: 1 addition & 1 deletion server/pages/components/Layout.js
Expand Up @@ -15,7 +15,7 @@ export default function Layout({ children }: Props) {
<html lang="en">
<head>
<Helmet>
<title>Atlas</title>
<title>Outline</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
</Helmet>

Expand Down
2 changes: 1 addition & 1 deletion server/pages/components/Navigation.js
Expand Up @@ -6,7 +6,7 @@ import { color } from '../../../shared/styles/constants';
function Navigation() {
return (
<Nav>
<Brand href="/">Atlas</Brand>
<Brand href="/">Outline</Brand>
<Menu>
<MenuItem><a href="/auth/slack">Sign In</a></MenuItem>
</Menu>
Expand Down
4 changes: 2 additions & 2 deletions server/static/dev.html
Expand Up @@ -2,7 +2,7 @@
<html>

<head>
<title>Atlas</title>
<title>Outline</title>
<link href="/static/styles.css" rel="stylesheet">
</head>
<style>
Expand Down Expand Up @@ -30,4 +30,4 @@
<script src="/static/bundle.js"></script>
</body>

</html>
</html>
4 changes: 2 additions & 2 deletions server/static/index.html
Expand Up @@ -2,7 +2,7 @@
<html>

<head>
<title>Atlas</title>
<title>Outline</title>
<style>
body,
html {
Expand All @@ -28,4 +28,4 @@
<script src="//d2wy8f7a9ursnm.cloudfront.net/bugsnag-3.min.js" data-apikey="<%= BUGSNAG_KEY %>"></script>
</body>

</html>
</html>
2 changes: 1 addition & 1 deletion webpack.config.dev.js
Expand Up @@ -24,7 +24,7 @@ developmentWebpackConfig.plugins.push(new webpack.HotModuleReplacementPlugin());
developmentWebpackConfig.plugins.push(new webpack.NoErrorsPlugin());
developmentWebpackConfig.plugins.push(
new HtmlWebpackPlugin({
title: 'Atlas',
title: 'Outline',
})
);

Expand Down

0 comments on commit f5c51a9

Please sign in to comment.