Merge pull request #207 from Hubs-Foundation/cloud-to-community

Recategorizes most "Hubs Cloud" docs as "Administration"

Author: Exairnous

README.md

@@ -1,6 +1,6 @@
 # Hubs Docs
 
-This repo is for the documentation for Hubs, and related products such as Hubs Cloud and Spoke. 
+This repo is for the documentation for Hubs, and related products such as Community Edition and Spoke.
 
 The documentation is under active development. If there are any changes or updates you recommend, feel free to submit a pull request or let us know in our [Discord Server](http://discord.gg/wHmY4nd).
 

docs/admin-adding-administrators.md

@@ -0,0 +1,30 @@
+---
+id: admin-adding-administrators
+title: Adding Administrators
+sidebar_label: Adding Administrators
+---
+
+## Powers
+
+Administrators for your hub have full access rights. They can:
+
+- Have access to the [Admin Console](./admin-getting-started) to update system settings and app configuration.
+- [Manage the content library](./admin-managing-content) and [import content](./admin-importing-content).
+- Have access to the [Scene Editor](./spoke-creating-projects.md) to create and publish new scenes, regardless of settings.
+
+## Granting Admin Access
+
+Community Edition does not store any personally identifying information in the database.
+To promote a user to administrator, first get from them the email address they use with your Hubs instance.
+
+Navigate to the **Accounts** section in the Admin Console:
+
+![Administration Accounts](img/hubs-cloud-accounts.jpeg)
+
+From there, enter their email address under **Find an account with an email address** and then click Find.
+
+![Administration Find Account](img/admin-find-account-email.png)
+
+Then set the account to **Is admin** and click **Save**:
+
+![Administration Select Admin](img/hubs-cloud-select-admin.jpeg)

docs/hubs-cloud-customizing-themes.md renamed to docs/admin-customizing-themes.md

@@ -1,5 +1,5 @@
 ---
-id: hubs-cloud-customizing-themes
+id: admin-customizing-themes
 title: Customizing Themes
 sidebar_label: Customizing Themes
 ---
@@ -14,7 +14,7 @@ _Theming refers to the colors used in your hub's interface. For each color in th
 
 ---
 
-# Theme JSON
+## Theme JSON
 
 You can add completely customized color schemes from the [Admin Panel](./setup-configuring-content.md) by copying and pasting a theme JSON, like the example below:
 
@@ -204,27 +204,27 @@ You can add completely customized color schemes from the [Admin Panel](./setup-c
 
 Use the boolean attributes, `"default"` and `"darkModeDefault"` to set a default theme from your custom themes array.
 
-# Theme Variables Guide
+## Theme Variables Guide
 
 While not exhuastive, these diagrams will outline a few key variables that you can use in your themes.
 
-## Entry Screen
+### Entry Screen
 
 <img src="img/theme-entry-screen.png" alt="Theme variable correlation on entry screen">
 
-## Bottom Toolbar
+### Bottom Toolbar
 
 <img src="img/theme-toolbar.png" alt="Theme variable correlation on bottom toolbar">
 
-## Menus
+### Menus
 
 <img src="img/theme-menus.png" alt="Theme variable correlation on menus">
 
-# In-App Themes
+## In-App Themes
 
 The in-world User Interface (e.g the menu you get when hovering your cursor over an object and pressing spacebar) is themed with the following variables: `"action-color", "action-label-color", "action-color-disabled", "action-color-highlight", "action-text-color", "action-subtitle-color", "notice-background-color", "notice-text-color", "favorited-color".`
 
-# Learn about Themes
+## Learn about Themes
 
 There are some great tools you can use to learn more about theme-ing your hub.
 

docs/hubs-cloud-enable-scene-editor.md renamed to docs/admin-enable-scene-editor.md

@@ -1,5 +1,5 @@
 ---
-id: hubs-cloud-enable-scene-editor
+id: admin-enable-scene-editor
 title: Recipe: Enable Scene Editor
 sidebar_label: Recipe: Enable Scene Editor
 ---
@@ -8,7 +8,7 @@ Hubs Cloud includes an unbranded version of [Spoke](http://hubs.local:3000/docs/
 
 Out of the box, it is disabled for non-administrators. If you want your users to be able to create and edit custom scenes when using your hub, you can enable the Scene Editor for all users.
 
-To do so, open the [Admin Console](./hubs-cloud-getting-started.md) then choose **App Settings**:
+To do so, open the [Admin Console](./admin-getting-started) then choose **App Settings**:
 
 ![Hubs Cloud App Settings](img/hubs-cloud-app-settings.jpeg)
 

docs/admin-getting-started.md

@@ -0,0 +1,41 @@
+---
+id: admin-getting-started
+title: Getting Started With Administration
+sidebar_label: Getting Started
+---
+
+## Admin Panel
+
+After successful Hubs deployment, navigate to your hub's hosted domain name (e.g. `myhub.com` or `hub.mydomain.com`). 
+
+In the upper right corner, click "Sign In" and enter the email address you set as `ADM_EMAIL` in `input-values.yaml`.
+In your email inbox, click the received "magic link" to login.
+
+Once you've logged into Hubs Community Edition for the first time, you should see the Hubs Admin Console.
+It should look like this:
+
+![Administration Admin Landing](img/admin-landing.png)
+
+If so, congratulations! You've successfully deployed your own personal Social VR hub, powered by Hubs by Hubs Foundation.
+
+You can always get back to the Admin Console by navigating to your site and looking for the "Admin" link in the top navigation bar:
+
+![Administration Admin Bar](img/navbar-admin.jpeg)
+
+## Creating a room
+
+Now that your site is up and running, you can create a room by clicking on the "Create a Room" link from the homepage:
+
+![Administration Create Room](img/homepage-create-room.jpeg)
+
+The first thing you'll notice... is your room is totally empty! Community Edition isn't very useful until you [import some scenes and avatars](./admin-importing-content).
+
+## Setting up your hub
+
+Here's some things you can do to continue setting up your hub:
+
+- [Import content](./admin-importing-content) so your visitors will have access to a library of scenes and avatars.
+- [Enable the Scene Editor](./admin-enable-scene-editor) to let visitors create their own scenes.
+- [Enable permissive rooms](./admin-permissive-rooms) to let visitors add media to their rooms.
+- [Learn how to manage content](./admin-managing-content) so visitors can contribute content to your hub.
+- [Add Administrators](./admin-adding-administrators) if you'd like others to help you set up your hub.

docs/hubs-cloud-importing-content.md renamed to docs/admin-importing-content.md

@@ -1,43 +1,43 @@
 ---
-id: hubs-cloud-importing-content
+id: admin-importing-content
 title: Importing Content
 sidebar_label: Importing Content
 ---
 
-The two forms of content you can import into Hubs Cloud are **avatars** and **scenes**. Avatars are 3D figures like robots, humans, and ducks that can be worn by visitors to represent themselves, and scenes are 3D environments like interiors and landscapes that provide visual grounding for a room.
+The two forms of content you can import into Community Edition are **avatars** and **scenes**. Avatars are 3D figures like robots, humans, and ducks that can be worn by visitors to represent themselves, and scenes are 3D environments like interiors and landscapes that provide visual grounding for a room.
 
-You can import any custom content you've created, either on [hubsfoundation.org](https://hubsfoundation.org), or using the tools like the [Scene Editor](./hubs-cloud-enable-scene-editor.md) available on your hub. For more information about the Scene Editor, see [Spoke Documentation](http://hubs.local:3000/docs/docs/spoke-creating-projects.html)[^1].
+You can import any custom content you've created, either on [demo.hubsfoundation.org](https://demo.hubsfoundation.org), or using the tools like the [Scene Editor](./admin-enable-scene-editor) available on your hub. For more information about the Scene Editor, see [Spoke Documentation](./spoke-creating-projects.md)[^1].
 
-### Admin Import Tool
+## Admin Import Tool
 
-To start importing content, navigate to the "Import Content" tool from the Admin Console. If you don't remember how to get to the Admin Console, see the [Getting Started](./hubs-cloud-getting-started.md) Guide.
+To start importing content, navigate to the "Import Content" tool from the Admin Console. If you don't remember how to get to the Admin Console, see the [Getting Started](./admin-getting-started) Guide.
 
-[^1]: 'Spoke' is the Hubs-Foundation trademarked name used for the Scene Editor on [hubsfoundation.org](https://hubsfoundation.org).
+[^1]: 'Spoke' is the Hubs Foundation trademarked name used for the Scene Editor on [demo.hubsfoundation.org](https://demo.hubsfoundation.org).
 
-![Hubs Cloud Import Content](img/hubs-cloud-import-content.jpeg)
+![Administration Import Content](img/hubs-cloud-import-content.jpeg)
 
 Once there, you'll need to specify a URL to import:
 
-![Hubs Cloud Import Content URL](img/hubs-cloud-import-content-url.jpeg)
+![Administration Import Content URL](img/hubs-cloud-import-content-url.jpeg)
 
 <!-- You can enter comma-separated URLs to scenes or avatars on another hub ([example scene](https://hubs.mozilla.com/scenes/rWgv5zN/winter-cheer), [example avatar](https://hubs.mozilla.com/avatars/PcJ8Sxb)). Or, you can specify a link to an [asset pack](./hubs-cloud-asset-packs.md). -->
 
 Once you've specified the content URL, you will see a preview of the content you're planning to import. You can then choose to exclude or include certain items and set special tags:
 
-![Hubs Cloud Import Content UI](img/hubs-cloud-import-ui.jpeg)
+![Administration Import Content UI](img/hubs-cloud-import-ui.jpeg)
 
 When ready, click the Import button to begin importing your content.
 
-### Special tags
+## Special tags
 You should also set the proper tags for the imported items for your hub to be ready to use:
 
 - Import at least one **Default** avatar, which new visitors will have by default.
 - Import at least one **Default** scene, which new rooms will have by default.
 - Import at least one **Base** avatar, which can easily be re-skinned by visitors.
 - Optionally **Feature** one or more items, which will cause those items to be easily discoverable by visitors.
 
-For more information about special tags, see [Managing Content](./hubs-cloud-managing-content.md).
+For more information about special tags, see [Managing Content](./admin-managing-content).
 
-### Updating Imported Content
+## Updating Imported Content
 
 To refresh content you've imported, simply import it again. If you've previously imported the same content, the existing avatar or scene in your hub will be updated in-place with the newest version of the imported content.

docs/admin-intro.md

@@ -0,0 +1,14 @@
+---
+id: admin-intro
+title: Introduction to Hubs Administration
+sidebar_label: Introduction
+---
+
+Your instance of Hubs Community Edition can be customized to match your organization, branding and needs.
+There are also tools to import assets and manage users.
+
+[//]: # (![Hubs Cloud](img/hubs-cloud-logo.jpeg))
+
+[//]: # (**NOTICE: HUBS CLOUD HAS BEEN REPLACED BY COMMUNITY EDITION.**)
+
+[//]: # (**Note: If you're looking for community Edition, which is the replacement for hubs cloud that you can bring anywhere as a dev, checkout [Hubs Community Edition](https://github.com/Hubs-Foundation/hubs-cloud/tree/master/community-edition)**)

docs/hubs-cloud-limiting-user-access.md renamed to docs/admin-limiting-user-access.md

@@ -1,5 +1,5 @@
 ---
-id: hubs-cloud-limiting-user-access
+id: admin-limiting-user-access
 title: Limiting User Access to your Hub
 sidebar_label: Limiting Access
 ---
@@ -11,22 +11,22 @@ This guide shows you how to lockdown your hub and rooms by **account only access
 To lockdown your instance, you remove account creation for non-admins and lock your instance to account access only. Before or after you lockdown your instance to accounts, as the hub admin, you can create accounts for a list of emails or disable existing accounts.
 
 1. **(Account management) Create accounts for approved emails**
-   1. Admin Panel > Accounts menu - [_NetworkError?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus)
+   1. Admin Panel > Accounts menu
    2. Batch create accounts (with optional identities)
       - Single example: email1,identity1
       - Multiple example: email1,identity1;email2;email3,identity3 with spaces;email4
 2. **(Account management) Remove access to existing accounts by "Disabling" accounts**
-   1. Admin Panel > Accounts menu - [_NetworkError?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus)
+   1. Admin Panel > Accounts menu
    2. Paste email address in "Find an account with an email address" text box
    3. Select "FIND"
    4. Change "State" dropdown to "disabled"
    5. Click "Save"
 3. **Remove account creation for non-admins**
-   1. Admin Panel > Setup: App Settings - [_Not Found page?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus)
+   1. Admin Panel > Setup: App Settings
    2. Select "Features" tab
    3. Enable "Disable account creation"
 4. **Lock your hub to only accounts can access**
-   1. Admin Panel > Setup: App Settings - [_Not Found page?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus)
+   1. Admin Panel > Setup: App Settings
    2. Select "Rooms" tab
    3. Enable "Require accounts for room access"
 
@@ -40,7 +40,7 @@ To lockdown your instance, you remove account creation for non-admins and lock y
 
 [Learn more about the Discord bot here](./hubs-discord-bot.md)
 
-[Enable the Discord bot for your Hubs Cloud instance](./hubs-cloud-discord-bot.md)
+[Enable the Discord bot for your Community Edition instance](./hubs-cloud-discord-bot.md)
 
 ## Room Access Settings
 

docs/hubs-cloud-managing-content.md renamed to docs/admin-managing-content.md

@@ -1,26 +1,26 @@
 ---
-id: hubs-cloud-managing-content
+id: admin-managing-content
 title: Managing Content
 sidebar_label: Managing Content
 ---
 
 In Hubs and Spoke, visitors can create their own avatars and scenes. They can then offer to share that content with others, which will let visitors discover the content through tools like the Media Browser.
 
-However, as the administrator of a hub, you don't always want the content contributed by visitors to be surfaced. For example, it may contain inappropriate or illegal content. Hubs Cloud comes with a set of content moderation tools, so you can fully control and filter the content submitted by your visitors.
+However, as the administrator of a hub, you don't always want the content contributed by visitors to be surfaced. For example, it may contain inappropriate or illegal content. Hubs Community Edition comes with a set of content moderation tools, so you can fully control and filter the content submitted by your visitors.
 
 ## Content Pipeline
 
 When a visitor creates a custom avatar or scene, they are offered the option to mark it as *remixable* and/or *promotable*. *Remixable* content confers a Creative Commons 3 license to the content so others are free to use or modify it, and *promotable* content will be enqueued for review to be added to your hub's content library. Once it is approved, content in the library can be discovered by users through tools like the Media Browser.
 
-All content marked as *Promotable* will be added to the **Pending Scene/Avatar Queue** when it is either created or updated. You can find these queues in your [Admin Console](./hubs-cloud-getting-started.md):
+All content marked as *Promotable* will be added to the **Pending Scene/Avatar Queue** when it is either created or updated. You can find these queues in your [Admin Console](./admin-getting-started):
 
-![Hubs Cloud Pending Queue Menu](img/hubs-cloud-pending-queue-menu.jpeg)
+![Administration Pending Queue Menu](img/hubs-cloud-pending-queue-menu.jpeg)
 
 ### Approving Content
 
 When viewing a queue, you will see a list of all the unreviewed scene or avatars that have been created or updated. From here, you have to decide if you are going to **Approve** or **Deny** the item by clicking one of the buttons on the far right:
 
-![Hubs Cloud Pending Scene](img/hubs-cloud-pending-scene.jpeg)
+![Administration Pending Scene](img/hubs-cloud-pending-scene.jpeg)
 
 - **Approving** an item will remove it from the queue and add it to the content library. If it's an update, the changes will be applied to the content library. Visitors will be able to discover the item through the Media Browser.
 
@@ -32,17 +32,17 @@ You can browse all of the approved content in the content library via the **Appr
 
 In addition to approving content, you can also **feature** content. Featuring content will place it on the **Featured** tab in the Media Browser, which will increase its visibility to your visitors:
 
-![Hubs Cloud Featured Content](img/hubs-cloud-featured.jpeg)
+![Administration Featured Content](img/hubs-cloud-featured.jpeg)
 
 To feature content, first you'll need to navigate to the content in the **Approved Scenes** or **Approved Avatars**. Once you've found content you'd like to feature, just click the **Feature** button. You can un-feature content that has been featured by using the **Unfeature** button.
 
-![Hubs Cloud Pending Scene](img/hubs-cloud-approved-scene.jpeg)
+![Administration Pending Scene](img/hubs-cloud-approved-scene.jpeg)
 
 ### Editing content
 
 To update content, click on the **Edit** button at the far right of the list for the item you want to edit. There you can edit the name, status, and tags of the item:
 
-![Hubs Cloud Edit Scene](img/hubs-cloud-edit-scene.jpeg)
+![Administration Edit Scene](img/hubs-cloud-edit-scene.jpeg)
 
 The **status** for the item can be set to **active** or **delisted**. When an item is delisted, it is effectively removed from the content library.
 

docs/hubs-cloud-permissive-rooms.md renamed to docs/admin-permissive-rooms.md

@@ -1,5 +1,5 @@
 ---
-id: hubs-cloud-permissive-rooms
+id: admin-permissive-rooms
 title: Recipe: Permissive Rooms
 sidebar_label: Recipe: Permissive Rooms
 ---
@@ -10,12 +10,12 @@ Room Permissions can be set on a room-by-room basis to allow more access to room
 
 However, sometimes you want to enable all permissions for all visitors for newly created rooms. For example, you may trust all visitors to your hub use features like media spawning and drawing responsibly.
 
-To change the default permissions of new rooms to be more permissive. First, open the [Admin Console](./hubs-cloud-getting-started.md) then choose **App Settings**:
+To change the default permissions of new rooms to be more permissive. First, open the [Admin Console](./admin-getting-started) then choose **App Settings**:
 
-![Hubs Cloud App Settings](img/hubs-cloud-app-settings.jpeg)
+![Administration App Settings](img/hubs-cloud-app-settings.jpeg)
 
 Then, under **Rooms**, enable the **Permissive Rooms** option and click **Save**:
 
-![Hubs Cloud Permissive Rooms](img/hubs-cloud-permissive-rooms.jpeg)
+![Administration Permissive Rooms](img/hubs-cloud-permissive-rooms.jpeg)
 
 Once selected, new rooms will have all permissions turned on by default for all visitors, not just the room creator and promoted members.

docs/dev-build-custom-client.md

@@ -3,4 +3,6 @@ id: build-custom-client
 title: Build a Custom Client
 ---
 
-If you are running a server using Hubs Cloud, you can deploy your custom client to your server. See [Hubs Cloud Custom Clients](./hubs-cloud-custom-clients.md) to see how.
+*under re-construction*
+
+[//]: # (If you are running a server using Community Edition, you can deploy your custom client to your server. See [Community Edition Custom Clients](./hubs-cloud-custom-clients.md) to see how.)

docs/hubs-cloud-accessing-servers.md

@@ -4,7 +4,7 @@ title: SSH Access
 sidebar_label: Advanced: SSH Access
 ---
 
-To access your servers over SSH, in the [Admin Console](./hubs-cloud-getting-started.md) choose **Server Access** and follow the guide. Note that 2-factor authentication is set up by default, so you will need a 2FA device with an application installed like Google Authenticator to connect to your servers.
+To access your servers over SSH, in the [Admin Console](./admin-getting-started) choose **Server Access** and follow the guide. Note that 2-factor authentication is set up by default, so you will need a 2FA device with an application installed like Google Authenticator to connect to your servers.
 
 Your servers are running [Ubuntu 18.04 Bionic Beaver](http://releases.ubuntu.com/18.04/).