Adding initial structure and content for 2.0 docs

pull/4/head
Nora 2018-12-13 13:45:38 -08:00
parent 2e124c6fbc
commit 746bf9a986
3 changed files with 132 additions and 0 deletions

View File

@ -0,0 +1,71 @@
---
title: Getting started
description: This is just an example post to show the format of new 2.0 posts
menu:
v2_0:
name: Getting started
weight: 1
---
## Onboarding (/setup)
* Set up your initial admin user.
Enter:
* Admin username
* Admin password/confirm
* Default organization name
* Default bucket name
* Click Next
* Select data sources to add to your bucket.
Pick from boxes showing sources
* Streaming
* Line protocol
* CSV
* Click Next
* Configure your data source.
* Lots of details, differs depending on source type.
* Type v1 or v2?
* Import protoboards for selected data sources
* Setup complete screen
* click Go to Status Dashboard?
* or does it link you to the User Homepage? Pretty sure its this.
## User Homepage (/)
* A jumping off point for everything the user has access to
* List of all dashboards they have access to
* List of all orgs they belong to
* List of all tasks they have access to
* Contains links to support related items:
* Technical documentation
* Community forum
* Report a bug
* Request a feature
* Version info
* Last commit
* Contains links to docs
* Manage my plan: A place to get notifications from Quartz
* A place to learn about new features and updates in each version
### Subpages
#### Account settings (/my-account)
* About Me:
* Username
* Email address
* Preferences
* Timezone
* Theme
* For both, Edit Changes then Save Changes
#### Tokens (/tokens)
* Table with Description, Last Used, and Organization columns
* Click on token name in Description column for Edit Token overlay
* Unlikely that user will use it, mostly in case of emergency
* Click on org name in Organization column to open organization page
* Generate token upper right
* Opens generate token overlay (tgo!)
* Also very unlikely that user will manually generate a token

View File

@ -0,0 +1,42 @@
---
title: Managing organizations
description: Describes how to manage organizations.
menu:
v2_0:
name: Managing organizations
weight: 1
---
# Create Organization
* Appears in upper right for users with permissions
* This one looks like theres significant difference between the mockups and the outline—ask
* Lists all orgs user belongs to
* User can filter list by organization name
## Sub pages:
### Organization (/organizations/orgnamehere)
#### Members (/organizations/orgnamehere/members)
* List all users who belong to this org
* Label users as either “Member” or “Owner”
* Owners can remove members from org
* Owners can invite users to be a member
#### Buckets (/organizations/orgnamehere/buckets)
* Members can see the buckets owned by this org
* Owners can CRUD buckets
* Owners can configure data sources tied to each bucket
#### Dashboards (/organizations/orgnamehere/dashboards)
* User can see all dashboards owned by this org
#### Tasks (/organizations/orgnamehere/tasks)
* User can see all dashboards owned by this org
#### Options (/organizations/orgnamehere/options) mockup says settings
* Only owners can see this tab
* Owner can change name of Organization
* Owner can modify permissions of an organization
* There will be more options here in the future
* Owner can disband organization

View File

@ -0,0 +1,19 @@
---
title: Using tasks
description: This is just an example post to show the format of new 2.0 posts
menu:
v2_0:
name: Example post
weight: 1
---
* User can see all tasks they have access to
* User can filter list by task name, owner, or date modified
* User can delete tasks with confirmation
* Click name of task to edit
## Task (/organizations/taskname/taskID)
* Only show Flux script in Text Editor
* Updated task options should be handled from options panel in UI
* Click to edit task name in page header