Skip to content

Commit a8a333c

Browse files
Merge pull request killbill#647 from reshmabidikar/update-aviate-docs
Minor corrections
2 parents 81776bf + 9e57a9b commit a8a333c

File tree

2 files changed

+31
-21
lines changed

2 files changed

+31
-21
lines changed

html5/_main_toc.html.slim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ nav.sidebar-nav
355355
| Aviate Changelog
356356
li.bd-sidenav-active
357357
a.nav-link href="/latest/aviate-getting-started.html"
358-
| Getting Started With Aviate
358+
| Getting Started
359359
li.bd-sidenav-active
360360
a.nav-link href="/latest/aviate-catalog-guide.html"
361361
| Aviate Catalog Guide

userguide/aviate/aviate-getting-started.adoc

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
In this guide, you will:
66

7-
* Use *Aviate* to configure your billing environment.
8-
* Switch to *Kaui* to create your first customer and subscription.
7+
* Use http://aviate.killbill.io[*Aviate*] to configure your billing environment.
8+
* Switch to http://demo.killbill.io[*Kaui*] to create your first customer and subscription.
99
* Generate and view an invoice.
1010
* Understand the role of *Kill Bill*, *Aviate*, and *Kaui*.
1111
* End up with a fully working fictive SaaS company set up for demos.
@@ -18,9 +18,9 @@ The example company used throughout this guide is *CloudSprout*, a fictional Saa
1818

1919
Before starting, it helps to understand how the pieces fit together.
2020

21-
* *Kill Bill* is the billing engine. It manages accounts, subscriptions, invoices, payments, and taxes.
22-
* *Aviate* is the Enterprise control and management plane. You use it to configure catalogs, taxes, invoice templates, and tenant settings, as well as proactively monitor the health of the billing engine.
23-
* *Kaui* is the billing operations UI. You use it for day-to-day actions such as creating customers, managing subscriptions, and reviewing invoices.
21+
* https://killbill.io/[*Kill Bill*] is the billing engine. It manages accounts, subscriptions, invoices, payments, and taxes.
22+
* http://aviate.killbill.io[*Aviate*] is the Enterprise control and management plane. You use it to configure catalogs, taxes, invoice templates, and tenant settings, as well as proactively monitor the health of the billing engine.
23+
* http://demo.killbill.io[*Kaui*] is the billing operations UI. You use it for day-to-day actions such as creating customers, managing subscriptions, and reviewing invoices.
2424

2525
In short:
2626

@@ -37,7 +37,7 @@ This checklist guides you through the minimum required setup to bill customers.
3737

3838
You should complete all steps in order.
3939

40-
=== Configure company settings
40+
=== Configure Company Settings
4141

4242
This step defines who you are as a business.
4343

@@ -63,7 +63,7 @@ The following demo shows how you can configure the company settings via Aviate.
6363

6464
''''
6565

66-
=== Configure the catalog
66+
=== Configure the Catalog
6767

6868
The catalog defines what you sell.
6969

@@ -72,16 +72,22 @@ For CloudSprout, create a simple catalog with:
7272
* A small number of subscription plans (for example Starter, Team, Business).
7373
* Optional add-ons (for example Extra Storage).
7474

75-
| Plan | GBP | EUR | Notes |
76-
| ----------- | ----------- | ----------- | ----------------- |
77-
| 🌱 Starter | £9 / month | €10 / month | Monthly only |
78-
| 🌿 Team | £29 / month | €32 / month | Monthly or annual |
79-
| 🌳 Business | £79 / month | €89 / month | Annual only |
75+
[cols="1,1,1,1", options="header"]
76+
|===
77+
| Plan | GBP | EUR | Notes
8078

81-
| Add-on | GBP | EUR | Billing |
82-
| ---------------- | --- | --- | ------- |
83-
| Extra Storage | £5 | €6 | Monthly |
84-
| Priority Support | £15 | €18 | Monthly |
79+
| 🌱 Starter | £9 / month | €10 / month | Monthly only
80+
| 🌿 Team | £29 / month | €32 / month | Monthly or annual
81+
| 🌳 Business | £79 / month | €89 / month | Annual only
82+
|===
83+
84+
[cols="1,1,1,1", options="header"]
85+
|===
86+
| Add-on | GBP | EUR | Billing
87+
88+
| Extra Storage | £5 | €6 | Monthly
89+
| Priority Support | £15 | €18 | Monthly
90+
|===
8591

8692
The following demo shows how you can create the `CloudSprout Starter` plan via Aviate.
8793
++++
@@ -99,9 +105,11 @@ image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/avi
99105

100106
This step only defines products and plans. No customers are created yet.
101107

108+
Refer to https://docs.killbill.io/latest/aviate-catalog-guide[Aviate Catalog Guide] for additional documentation.
109+
102110
''''
103111

104-
=== Configure taxes
112+
=== Configure Taxes
105113

106114
Taxes are configured in Aviate and applied automatically by Kill Bill.
107115

@@ -124,6 +132,8 @@ The following demo explains how you can configure the above tax codes:
124132
</div>
125133
++++
126134

135+
Refer to https://docs.killbill.io/latest/aviate-tax[Aviate Tax] for additional documentation.
136+
127137
''''
128138

129139
== Step 2: Switch to Kaui (Billing Operations)
@@ -144,7 +154,7 @@ The following demo illustrates how you can switch to Kaui:
144154

145155
''''
146156

147-
=== Create your first customer
157+
=== Create Your First Customer
148158

149159
In Kaui:
150160

@@ -169,7 +179,7 @@ The following demo illustrates the account creation process in Kaui:
169179

170180
At this point, you have a customer but no billing activity yet.
171181

172-
=== Create a subscription
182+
=== Create a Subscription
173183

174184
Next, attach a subscription to the customer.
175185

@@ -194,7 +204,7 @@ The following demo guides you through the subscription creation process in Kaui:
194204

195205
''''
196206

197-
=== View the invoice
207+
=== View The Invoice
198208

199209
Once the subscription is active:
200210

0 commit comments

Comments
 (0)