Org Settings documetation & Getting Started docs page updates
This commit is contained in:
parent
2364433932
commit
79703baa69
@ -40,6 +40,8 @@ Webrecorder is a global team but we use American English when writing documentat
|
||||
|
||||
In a list of three or more items, the list item proceeding the word "and" should have a comma placed after it clarifying that the final item in the list is not a part of the previous item.
|
||||
|
||||
##### Example
|
||||
|
||||
| Use | Don't use |
|
||||
| ----------------------------- | ---------------------------- |
|
||||
| One, two, three, and four. | One, two, three and four. |
|
||||
@ -49,14 +51,28 @@ In a list of three or more items, the list item proceeding the word "and" should
|
||||
|
||||
Avoid using acronyms when reuse is not frequent enough to warrant space savings. When acronyms must be used, spell the full phrase first and include the acronym in parentheses `()` the first time it is used in each document. This can be omitted for extremely common acronyms such as "URL" or "HTTP".
|
||||
|
||||
##### Example
|
||||
|
||||
> When running in a Virtual Machine (VM), use the....
|
||||
|
||||
### Headings
|
||||
|
||||
All headings should be set in [title case](https://en.wikipedia.org/wiki/Title_case).
|
||||
|
||||
##### Example
|
||||
|
||||
> Indiana Jones and the Raiders of the Lost Ark
|
||||
|
||||
### Referencing Features and Their Options
|
||||
|
||||
Controls with multiple options should have their options referenced as `in-line code blocks`.
|
||||
|
||||
Setting names referenced outside of a heading should be Capitalized and set in _italics_.
|
||||
|
||||
##### Example
|
||||
|
||||
> Sets the day of the week for which crawls scheduled with a `Weekly` _Frequency_ will run.
|
||||
|
||||
### Markdown Formatting
|
||||
|
||||
All of Webrecorder's markdown-based docs are written in [GitHub Flavored Markdown](https://github.github.com/gfm/).
|
||||
|
@ -58,13 +58,14 @@
|
||||
/* Custom menu item hover */
|
||||
|
||||
.md-tabs__link {
|
||||
font-family: var(--md-code-font);
|
||||
font-weight: 400;
|
||||
opacity: .9;
|
||||
transition: .4s cubic-bezier(.1,.7,.1,1),opacity .25s
|
||||
}
|
||||
|
||||
.md-tabs__link:hover {
|
||||
font-weight: 500;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
/* Custom body typography rules */
|
||||
|
@ -1,15 +1,19 @@
|
||||
# Getting Started
|
||||
|
||||
Welcome to Browsertrix Cloud. This Guide will cover various aspects of using Browsertrix Cloud.
|
||||
## Signup
|
||||
|
||||
For all signup options the Name field cannot currently be changed later.
|
||||
|
||||
## Creating an Account
|
||||
### Invite Link
|
||||
|
||||
- If you have been given an invite, you can create an account for that email address. Choose a password and name to create a new account.
|
||||
If you have been sent an [invite](org-settings#members), enter a password and name to create a new account. Your account will be added to the organization you were invited to by an organization admin.
|
||||
|
||||
- If you have been given a registration link, you can enter your email address, password and name to create a new account.
|
||||
### Open Registration
|
||||
|
||||
If the server has enabled signups and you have been given a registration link, enter your email address, password, and name to create a new account. Your account will be added to the server's default organization.
|
||||
|
||||
## Quick Start
|
||||
---
|
||||
|
||||
Once you've registrated, your account will have an `[Your Name's Archive]` where you can create workflows to run crawls!
|
||||
## Automated Crawling
|
||||
|
||||
A Workflow must be created in order to crawl websites automatically. Workflows can be created on the Crawling page found in the main navigation menu. A detailed list of all available workflow configuration options can be found on the [Crawl Workflow Setup](workflow-setup) page.
|
15
docs/user-guide/org-settings.md
Normal file
15
docs/user-guide/org-settings.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Org Settings
|
||||
|
||||
The Org Settings page is only available to organization Admins. It can be found in the main navigation menu.
|
||||
|
||||
## Org Information
|
||||
|
||||
This page lets you change the organization's name. This name must be unique.
|
||||
|
||||
## Members
|
||||
|
||||
This page lists all current members who have access to the organization, as well as any invited members who have not yet accepted an invitation to join the organization. In the _Active Members_ table, Admins can change the permission level of all users in the organization, including other Admins. At least one user must be an Admin per-organization. Admins can also remove members by pressing the trash button.
|
||||
|
||||
Admins can add new members to the organization by pressing the `Invite New Member` button. Enter the email address associated with the user, select the appropriate role, and press `Invite` to send a link to join the organization via email.
|
||||
|
||||
Sent invites can be invalidated by pressing the trash button in the relevant _Pending Invites_ table row.
|
@ -1,6 +1,6 @@
|
||||
# Workflow Setup
|
||||
# Crawl Workflow Setup
|
||||
|
||||
The first step in creating a new workflow is to choose what type of crawl you want to run. Crawl types are fixed and cannot be converted or changed later.
|
||||
The first step in creating a new crawl workflow is to choose what type of crawl you want to run. Crawl types are fixed and cannot be converted or changed later.
|
||||
|
||||
`URL List`{ .badge-blue }
|
||||
: The crawler visits every URL specified in a list, and optionally every URL linked on those pages.
|
||||
@ -159,11 +159,11 @@ Set how often a scheduled crawl will run.
|
||||
|
||||
### Day
|
||||
|
||||
For crawls scheduled with a `Weekly` _Frequency_, sets the day of the week for which the crawl will run.
|
||||
Sets the day of the week for which crawls scheduled with a `Weekly` _Frequency_ will run.
|
||||
|
||||
### Date
|
||||
|
||||
For crawls scheduled with a `Monthly` _Frequency_, sets the date of the month for which the crawl will run.
|
||||
Sets the date of the month for which crawls scheduled with a `Monthly` _Frequency_ will run.
|
||||
|
||||
### Start Time
|
||||
|
||||
|
@ -57,6 +57,7 @@ nav:
|
||||
- User Guide:
|
||||
- user-guide/index.md
|
||||
- user-guide/workflow-setup.md
|
||||
- user-guide/org-settings.md
|
||||
|
||||
markdown_extensions:
|
||||
- toc:
|
||||
|
Loading…
Reference in New Issue
Block a user