Merge pull request #240 from flotiq/feature/24554-spaces-docs

Spaces and Organization docs #24554

docs/panel/index.md

@@ -8,6 +8,13 @@ After logging in you will see Flotiq's dashboard, by default it will show a welc
 
 ![Flotiq dashboard](images/Dashboard.png)
 
+The Dashboard you see contains information about the Space within which you are working. If you have access to multiple Spaces, you can switch contexts by clicking on the desired Space.
+
+![Flotiq dashboard - spaces](images/DashboardSpaces.png)
+
+!!! note
+    Read more about Spaces in [Spaces and Organization section](/docs/panel/spaces/).
+
 ## Content Type Definitions
 
 This part of Flotiq's interface will be your starting point whenever you begin working with new kind of data. In here you will find your existing Content Type Definitions, presented in a tile grid

docs/panel/spaces.md

@@ -0,0 +1,109 @@
+title: Spaces and Organization
+description: How to manage Spaces in Flotiq.
+
+## What is a Space?
+
+A Space is a workspace that groups data in terms of a single, separate project.
+Content does not overlap between Spaces. 
+This means that a user assigned to a particular Space will only see content from that Space.
+
+Key Characteristics of a Space:
+
+* **Content Isolation:** Content within a Space does not overlap with other Spaces, ensuring distinct boundaries.
+* **Individual Usage Limits:** Each Space maintains its own separate usage limits, ensuring
+* **Visibility Restrictions:** Users assigned to a particular Space will only have access to content within that Space, enhancing security and relevance of information.
+
+Space groups content of the Organization such as: `Content Objects`, `Content Type Definitions`, `Media`, `API keys`, `Plugins`, `Webhooks`, and `Users`.
+
+!!! Example
+    This is what the content of an example Space for the "News Site" project might look like. Notice which elements belong to this specific Space:
+
+    - **Name**: News Site Space
+    - **Plan**: PRO
+    - **Content Type Definitions**: Media, News, Category, Author, Comments
+    - **API Keys**: ReadOnly, ReadWrite, ReadNews, PostComment
+    - **Enabled Plugins**: Netlify Build
+    - **Webhooks**: OnNewsUpdate
+    - **Users**: [email protected], [email protected]
+
+Each Space has its own separate payment plan, meaning that **usage limits are calculated separately for each Space**. This ensures clarity in billing and resource management for different projects.
+
+## What is an Organization?
+
+An Organization is essentially a collection of Spaces. Within an Organization, the administrator has several key responsibilities:
+
+- **Manage Spaces:** Administrators can oversee various Spaces, tailoring each to meet specific project needs.
+- **Assign Plans and Control Usage:** Administrators are responsible for assigning specific payment plans to each Space and monitoring usage limits.
+- **User Management:** Administrators handle the overall user management within the Organization, including assigning users to appropriate Spaces.
+
+Roles within an Organization:
+
+- **Organization Admin:** Has full control over management privileges, including the ability to manage Spaces and users.
+- **Organization User:** Restricted to operating within Spaces specifically assigned by an Administrator, focusing solely on content related to that Space.
+
+## Navigating Through Spaces
+
+Every user with access to one or more Spaces will see a Spaces selector above the main application menu.
+
+![Spaces Selector in Flotiq Dashboard](images/spaces/SpacesSelector.png)
+
+Depending on the selected Space, the context of the application changes - the contents displayed by the Dashboard are relevant to the chosen Space.
+
+## Managing Spaces
+
+!!! note
+    This feature is available to users with the role of `Organization Admin`.
+
+To manage your Spaces, navigate to the `Organization Settings` section of the application.
+
+![Go to organization Settings, Flotiq Dashboard](images/spaces/SpaceOrgSettings.png)
+
+### List spaces 
+
+The `Spaces and Usage` list provides essential details about your Spaces within the Organization. 
+
+This overview allows you to:
+
+* View current usage of resources for each Space.
+* Access and modify the settings of a Space (Edit Space).
+* Change the payment plan associated with a Space (Upgrade Space).
+* Access the subscription dashboard where you can review billing documents (Manage subscription panel).
+
+![Spaces and Usage view in Flotiq Dashboard](images/spaces/SpacesAndUsage.png)
+
+
+### Add Space
+
+In the Space addition view, an Organization Administrator can assign a name to the Space and select the usage limits that will be available for the Space. 
+If a paid option is selected, the Administrator will be redirected to the payment view.
+
+![Add a new Space to your Flotiq account](images/spaces/SpaceAdd.png)
+
+### Edit Space
+
+In the Space editing view, an Organization Administrator can change the name of the Space, manage users within the Space, and view the limits for the given Space.
+
+![Edit Space settings](images/spaces/SpaceEdit.png)
+
+### Upgrade Space
+
+To change the plan for a Space, the Administrator can select the “Upgrade Space” option from the Spaces list.
+
+![Upgrading Space](images/spaces/SpaceUpgrade.png)
+
+When the administrator changes the plan:
+
+* **From free to paid** - the user will be redirected to the payment screen.
+* **From paid to another paid plan** - a confirmation will be displayed, and the details of the billing will be available in the `Manage Subscription` section on the Spaces list. Billing adjustment will occur at the end of the billing period.
+* **From paid to free** - the subscription cancellation will be scheduled to coincide with the end of the current billing period.
+
+## Manage Users in Organization
+
+Administrators can manage users outside the Space context. 
+This allows Administrators to have an overview of all users within the Organization.
+
+Users can be added independently of Spaces, without being assigned to a specific Space.
+
+To display the user list, navigate to the `Users` tab in the Organization management view.
+
+![Users in Organization](images/spaces/SpaceUsers.png) 

mkdocs.yml

@@ -132,6 +132,7 @@ nav:
     - 'Workflows': 'API/workflow/content-publishing-workflow.md'
   - Dashboard:
     - 'Overview': panel/index.md
+    - 'Spaces and Organization': panel/spaces.md
     - 'Content types': panel/content-types.md
     - 'Flotiq Forms': panel/flotiq-forms-add-forms-to-websites.md
     - 'Predefined Content Types': panel/predefined-content-types.md