-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: wambuipixel <[email protected]>
- Loading branch information
1 parent
e6e6bf3
commit 2da4310
Showing
16 changed files
with
198 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
--- | ||
title: Billing | ||
--- | ||
|
||
This service allows users to view and subscribe to billing plans, manage payment methods and billing information, and download generated invoices and receipts. | ||
Magistrala employs the use of **Stripe** to handle the User's private information. | ||
This means that Magistrala will not have the user's card payment credentials at any point in time. | ||
|
||
Navigate to the Billing tab on the sidenav bar. This tab will only be visible to admin members of a domain. | ||
 | ||
|
||
### Overview | ||
The billing page has multiple sections present each important to the billing process. | ||
|
||
 | ||
|
||
In a newly created domain without any data on billing, all the sections will be empty. | ||
|
||
|
||
### Subscribe to a Billing Plan | ||
The subscription section handles the domain's subscription plan and shows the status of the subscription. | ||
|
||
The first step is to add a billing plan to the domain this done by clicking 'Choose' will display a list of available subscription plans. | ||
|
||
 | ||
|
||
The subscription status can be either be **completed** where the user has already been charged or **incomplete** where the process is not yet done and the subscription is inactive. | ||
|
||
The **plan details** generally show the user the limits of their subscribed plan. This ensures they are aware of their restrictions at all times. These limits define what can be accessed in terms of domains, users, groups, and devices. | ||
|
||
### Add Billing Information | ||
The first part of the Billing section is Billing Information, which includes the user's contact details such as addresses, emails, and the name of the user to whom the subscription will be charged. | ||
 | ||
|
||
To fill this section, click on 'Add' to trigger a dialogbox. | ||
On the form, you are required to fill in the Name, Email, Phone, Country and City of the billed customer. | ||
State and Province or Addresses are not that important but do help in the creation of invoices. | ||
After filling in the required data, click 'Add' and the information will be fed into the system. | ||
|
||
 | ||
|
||
Now with a working Billing Information, you can add the payment method. | ||
|
||
### Add a Payment Method | ||
Click on the 'Add' button to gain access to the stripe page where you will fill in your cards or paypal information. | ||
A succesful update will lead you back to the Magistrala Biling page with an active payment method. | ||
|
||
 | ||
|
||
You can add as many payment cards as needed. | ||
Each card will be verified by stripe to prevent any fradulent cards from being accepted. Ensure that the card has sufficient funds to cover the subscription cost. | ||
You can also edit payment methods, set a default card and delete any payment method. | ||
|
||
 | ||
|
||
To set a payment method as default simply select 'Set as default' in the dropdown. Once payment method has been set as default, a badge showing default appears. To delete a payment method simply select 'delete' on the dropdown and the payment method will be deleted. | ||
|
||
### Generate an Invoice | ||
Once the plan is selected, an invoice will be generated that can be downloaded by clicking the invoice icon downloads a pdf with all the required data. | ||
 | ||
|
||
|
||
### Generate a Receipt | ||
Once payment is received, there will be an receipt generated that a user can download by clicking on the receipt icon. | ||
|
||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
title: Domain | ||
--- | ||
|
||
### Domain Information | ||
|
||
Navigate to the `Domain` section in the side navigation under **Domain Management** to find out more about the domain. | ||
|
||
Here a user can edit the Domain Name, Alias, Tags and Metadata as well as copy the Domain ID. | ||
|
||
The Domain status can be disabled by clicking the 'Disable' button or enabled by the 'Enable' button. Disabling the domain will revoke the access for users who are not domain admins. | ||
|
||
 | ||
|
||
### Domain Roles | ||
|
||
Domain Management covers the Roles and Role Actions present in a domain as well. From the Roles section of the Domain, the user can create new roles with varying role actions. | ||
|
||
By default, an admin role with complete control over the domain is always present and granted to the Domain creator. | ||
|
||
 | ||
|
||
This is a Domain Role Actions Comprehensive List: | ||
|
||
- **General Actions** | ||
- update | ||
- enable | ||
- disable | ||
- read | ||
- delete | ||
|
||
- **Role Management** | ||
- manage_role | ||
- add_role_users | ||
- remove_role_users | ||
- view_role_users | ||
|
||
- **Client Actions** | ||
- client_create | ||
- client_update | ||
- client_read | ||
- client_delete | ||
- client_connect_to_channel | ||
- client_set_parent_group | ||
- client_manage_role | ||
- client_add_role_users | ||
- client_remove_role_users | ||
- client_view_role_users | ||
|
||
- **Channel Actions** | ||
- channel_create | ||
- channel_update | ||
- channel_read | ||
- channel_delete | ||
- channel_set_parent_group | ||
- channel_connect_to_client | ||
- channel_publish | ||
- channel_subscribe | ||
- channel_manage_role | ||
- channel_add_role_users | ||
- channel_remove_role_users | ||
- channel_view_role_users | ||
|
||
- **Group Actions** | ||
- group_create | ||
- group_update | ||
- group_read | ||
- group_delete | ||
- group_membership | ||
- group_set_child | ||
- group_set_parent | ||
- group_manage_role | ||
- group_add_role_users | ||
- group_remove_role_users | ||
- group_view_role_users | ||
|
||
To create a new role, click on the `+ Create` button and select from the role actions as well as provide a descsriptive name for the role. | ||
|
||
Since currently we cannot assign members to a domain, the only way to get members is by creating roles and selecting users to the roles. | ||
|
||
 | ||
|
||
Once created, these domain roles can be edited in their respective ID pages. | ||
A user can edit the domain role id, name, role actions and role members. These fields can all be edited accordingly while on the page or by using the options on the dropdown menu. | ||
|
||
 | ||
 | ||
|
||
### Domain Members | ||
|
||
An admin or a member with the right permissions can assign users to a domain. Members must be assigned with specific roles. | ||
|
||
> This feature is currently under maintenance | ||
 | ||
|
||
Using the search feature allows a user to easily navigate the members to find particular users. | ||
The **Status** button can filter the members table and show enabled, disabled or all the members. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Introduction | ||
--- | ||
|
||
This section will detail management of a **domain**, **invitations** and **billing services**. Under domain management a user will be able to update domain details such as name, alias, metadata as well as enabling or disabling the domain. | ||
|
||
Within the billing section a user will be able to manage subscriptions, add or update billing plans, add payment methods, download invoices and receipts. Lastly, in the invitations section a user is able to manage sent and received invitations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: Invitations | ||
--- | ||
|
||
### Send Invitation | ||
The **Invitations** Tab shows the list of invitations a user has sent out to other members of the domain. | ||
After clicking on the 'Send Invitation' button, a user can select multiple users with a specific relation to invite to the Domain. | ||
|
||
 | ||
|
||
 | ||
|
||
### Accept an Invitation | ||
|
||
Once the invitation is sent, the user will be able to accept or decline it after they log in. | ||
There will be a popup on the domains page showing all the pending invitations. | ||
The user does have an option of accepting or declining the invitation on the popup. This will have a maximum of 5 messages which reload after every invitation has been accepted or declined. | ||
|
||
 | ||
|
||
They can also view more invitations after clicking View all which links them to the Invitations Table. | ||
|
||
 | ||
|
||
Once the Invitation is accepted, the User will be able to log into the Domain. They can be found on the Members Table in the domain with the right Permissions. | ||
|
||
 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.