Skip to content

Commit 1399829

Browse files
author
kmidkiff
committed
more usage guide added
1 parent 9635f24 commit 1399829

14 files changed

+89
-7
lines changed

docs/add_payment_method.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#Adding a Payment method
2+
3+
After a user has been created in the system, they can view all the public services and manage their account. To be able to request services the user must have a payment method configured.
4+
5+
1. Log in with a User account
6+
2. Select _Billing_ -> _Billing Settings_
7+
![Screenshot](./images/billing_settings.png)
8+
9+
3. Enter your card information and select _Add Payment Method_
10+
![Screenshot](./images/add_payment_method.png)
11+

docs/approve_service.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
If you are a user and an Administrator requested a service on your behalf, then you must approve that service.
2+
3+
1. Log in with user account
4+
2. Select _My Services_
5+
6+
![Screenshot](./images/my_services.png)
7+
8+
3. Select _Approve_. Instances awaiting approval will only give you the option of Approve. You can click the instance before approving to view the details of the service.
9+
10+
![Screenshot](./images/approve_service.png)
11+
12+
4. If you do not have a payment method set up, the system will ask you to add one, or you can follow the [guide](./add_payment_method.md)
13+
14+
![Screenshot](./images/payment_setup.png)

docs/create_template.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,33 @@
66
![Screenshot](./images/create_new_service.png)
77
4. Fill out the form fields provided
88

9-
| Field Name | Description | Example Value |
10-
| ------------- |:-------------:| -----:|
9+
| Field Name | Description | Example Value | Possible Values |
10+
| ------------- |:-------------:| -----:| -----:|
1111
| Service Name | Name of the service template which will be displayed on the item thumbnail from the homepage catalog | `Small Website` |
1212
| Summary | Summary of the service template which will be displayed on the item thumbnail from the homepage catalog | `Development of custom small CMS managed website (less than 10 pages)` |
13-
| Service Details | Detailed description of the service template. This will be displayed when a user selects _view_ from the homepage catalog. You can use html tags in your service details | `We can build you a ` |
14-
| Published? | Whether or not this service template is to be displayed on the homepage catalog | `Yes` |
15-
| Category | Category for the service template to be put in. Templates can be filtered by the category on the homepage catalog | `Small Website` |
16-
| Service Details | are neat | `Small Website` |
13+
| Service Details | Detailed description of the service template. This will be displayed when a user selects _view_ from the homepage catalog. You can use html tags in your service details | `We can build you a <strong>custom</strong> website!` |
14+
| Published? | Whether or not this service template is to be displayed on the homepage catalog | `Yes` | `Yes`, `No` |
15+
| Category | Category for the service template to be put in. Templates can be filtered by the category on the homepage catalog | `Web Development` | List available from Categories Created |
16+
| Trial Period (Days) | Number of days for a trial period of the service | `0` | Greater than 0 |
17+
| Currency | Number of days for a trial period of the service | `USD` | [Available currencies](https://support.stripe.com/questions/which-currencies-does-stripe-support) |
18+
| Service Type | <ul><li>Subscription Service - For reoccurring charges.</li><li>One-Time Service - For one time charges</li><li>Custom Service - For custom services whose prices can change at purchase</li></ul> | `Subscription Service` | `Subscription Service`, `One-Time Service`, `Custom Service` |
19+
| Trial Period (Days) | Number of days for a trial period of the service | `0` | Greater than 0 |
20+
| Service Subscription Amount | Price for the service template | `2777.68` | Greater than 0 |
21+
| Subscription Interval | The time between a reoccurring service | `Monthly` | `Daily`, `Weekly`, `Monthly`, `Yearly` |
22+
| How Many "Interval"? | The number of occurrences of the service | `12` | Greater than 0 |
23+
| Prorated? | If your service billing should include partial time intervals. More on proration [here](https://stripe.com/docs/subscriptions/upgrading-downgrading#understanding-proration) | `Yes` | `Yes`, `No` |
1724

25+
5. Enter Custom Fields
26+
![Screenshot](./images/custom_field.png)
27+
28+
| Field Name | Description | Example Value | Possible Values |
29+
| ------------- |:-------------:| -----:| -----:|
30+
| Label | The display value for the field to be displayed in the form | `What's your name?` |
31+
| Input Type | The type of input for the field to be displayed in the form | `Text Box` | `Text Box`, `Select List`, `Check Box` |
32+
| Default Value | The default value for the field to be displayed in the form | `Jeff` |
33+
| Private? | If this field should be hidden from the form. Can be used to store configuration data or other cross template properties | `No` | `Yes`, `No` |
34+
| Required? | If this field must have a value to submit the request | `Yes` | `Yes`, `No` |
35+
| Prompt User | If this field should be propted for the user to fill out. If this is "No" and Private is "No", the property name and value will be displayed in the form with no option to change the value | `No` | `Yes`, `No` |
36+
37+
5. Click _Create Service_
38+
![Screenshot](./images/create_service.png)

docs/images/add_payment_method.png

76.8 KB
Loading

docs/images/approve_service.png

11.8 KB
Loading

docs/images/billing_settings.png

35.3 KB
Loading

docs/images/create_service.png

27.3 KB
Loading

docs/images/custom_field.png

46.9 KB
Loading

docs/images/my_services.png

11.4 KB
Loading

docs/images/payment_setup.png

100 KB
Loading

docs/images/request_service.png

56.8 KB
Loading

docs/images/submit_request.png

17.4 KB
Loading

docs/request_service.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#Request a Service
2+
There are two ways to request a service instance. As an Admin, you can requests instances on behalf of a user. As a new user to the system you can request for yourself. The same process is done for both, except if you requested on behalf of a user it will require approval from the user.
3+
4+
1. Log into ServiceBot instance
5+
2. Select _Request_
6+
![Screenshot](./images/request_service.png)
7+
3. Fill in Basic info __if you are an Administrator__
8+
9+
| Field Name | Description | Example Value | Possible Values |
10+
| ------------- |:-------------:| -----:| -----:|
11+
| For Client | The customer who you are requesting on behalf of | `email@domain.com` |
12+
| Name | Name for the service instance. If you don't provide one the name will be inherited from the template it was requested from | `Small Website` |
13+
| Description | Description for the service instance. If you don't provide one the description will be inherited from the template it was requested from | `email@domain.com` |
14+
15+
Advanced
16+
17+
18+
| Field Name | Description | Example Value | Possible Values |
19+
| ------------- |:-------------:| -----:| -----:|
20+
| Published? | Whether or not this service template is to be displayed on the homepage catalog | `Yes` | `Yes`, `No` |
21+
| Category | Category for the service template to be put in. Templates can be filtered by the category on the homepage catalog | `Web Development` | List available from Categories Created |
22+
| Trial Period (Days) | Number of days for a trial period of the service | `0` | Greater than 0 |
23+
| Currency | Number of days for a trial period of the service | `USD` | [Available currencies](https://support.stripe.com/questions/which-currencies-does-stripe-support) |
24+
| Service Type | <ul><li>Subscription Service - For reoccurring charges.</li><li>One-Time Service - For one time charges</li><li>Custom Service - For custom services whose prices can change at purchase</li></ul> | `Subscription Service` | `Subscription Service`, `One-Time Service`, `Custom Service` |
25+
| Trial Period (Days) | Number of days for a trial period of the service | `0` | Greater than 0 |
26+
| Service Subscription Amount | Price for the service template | `2777.68` | Greater than 0 |
27+
| Subscription Interval | The time between a reoccurring service | `Monthly` | `Daily`, `Weekly`, `Monthly`, `Yearly` |
28+
| How Many "Interval"? | The number of occurrences of the service | `12` | Greater than 0 |
29+
| Prorated? | If your service billing should include partial time intervals. More on proration [here](https://stripe.com/docs/subscriptions/upgrading-downgrading#understanding-proration) | `Yes` | `Yes`, `No` |
30+
31+
4. Fill in the custom fields of the form
32+
5. Select _Submit Request_
33+
![Screenshot](./images/submit_request.png)
34+
35+
######(Note: If you are an administrator requesting the service on behalf of a user, the instance will need to be Approved)

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ pages:
1515
- Installation: install.md
1616
- Usage:
1717
- Create Account: create_account.md
18+
- Add a Payment Method: add_payment_method.md
1819
- Create a Service Template: create_template.md
19-
- Roles: roles.md
2020
- Request a Service: request_service.md
2121
- Approve a Service: approve_service.md
2222
- Messaging: messaging.md
23+
- Roles: roles.md
2324
- Change operation mode: operation_mode.md
2425
- Change Branding: branding.md
2526
- Change Theme: theme.md

0 commit comments

Comments
 (0)