work for ts 284#690
Conversation
There was a problem hiding this comment.
Looks good - left a few comments. Also, we should add a section about Aviate - explains what it is, point to docs, explain differences (new features), setup, ...
Perhaps another thing to add are a few examples for create scripts so we could use this skill to quickly create scripts. E.g.
Example of a script to create a tenant, customer account, catalog plan, subscription and check for invoicing - scripts take a params
• Env: deployment URLs
• Plan {monthly recurring $10/month}
...
Note that the skills.md does not yet include information for Aviate. We can do this in a subsequent pass.
👍 I had missed this in your comment
|
|
||
| ## Understand Kill Bill and Getting Started with Kill Bill | ||
|
|
||
| - https://docs.killbill.io/latest/what_is_kill_bill.html |
There was a problem hiding this comment.
I think we should add a 1-liner to explain what is each doc
| **Primary docs:** | ||
| - https://docs.killbill.io | ||
| - https://apidocs.killbill.io | ||
| - https://github.com/killbill |
There was a problem hiding this comment.
That one is not really about doc- should rename the section to 'Key resources' - we could also add our marketing web site in the list. Add a 1-liner description for each.
Update I see you also have a Resources section below, so maybe this is fine and just remove https://github.com/killbill from here as long as it's part of resources below.
| 2. Mention version-specific behavior when relevant. | ||
| 3. If multiple approaches exist, recommend the simplest supported approach first. | ||
| 4. Prefer configuration over custom code when possible. | ||
| 5. When discussing plugins, clearly distinguish between: |
There was a problem hiding this comment.
Also had a mention about public plugins (offered through our Marketplace) and private/custom plugins
| kpm diagnostic --killbill-api-credentials=bob lazar --killbill-credentials admin password --account-export=ACCOUNT_ID | ||
|
|
||
| # Docker quick start | ||
| docker compose up |
There was a problem hiding this comment.
Something is missing here - and should it go in its own section?
|
|
||
| ### Kill Bill setup | ||
|
|
||
| Kill Bill itself needs a database (MySQL is the most commonly used/tested, PostgreSQL and MariaDB are also supported) and can be installed several ways depending on environment: a single-tier AWS AMI (quick trial/experimentation), a multi-tier AWS setup or CloudFormation templates (recommended for production), Docker/Docker Compose (local or cloud), or a manual Tomcat installation. |
There was a problem hiding this comment.
Add reference to the DDL schema
| - **Phase** — A stage within a plan's lifecycle (trial, discount, evergreen), each with its own duration and price | ||
| - **Price List** — A named grouping of plans in the catalog, used to offer different pricing tiers for the same products | ||
| - **Catalog** — The XML configuration defining products, plans, phases, price lists, and business rules | ||
| - **BCD (Bill Cycle Day)** — The day of the month that invoice is created for an account |
There was a problem hiding this comment.
Maybe add this only applies for monthly-based billing periods - e.g. Quarterly, but not Weekly. Also add this can be configured at the Account level (default) or overridden per subscription.
|
|
||
| --- | ||
|
|
||
| ## Common gotchas |
There was a problem hiding this comment.
This is great - how did you compile this list?
|
|
||
| --- | ||
|
|
||
| > For additional documentation and navigation, see: https://docs.killbill.io |
There was a problem hiding this comment.
We have this 3x in the doc, we can probably remove this one.
2 participants
Did a first pass for https://github.com/killbill/technical-support/issues/284. Note that the
skills.mddoes not yet include information for Aviate. We can do this in a subsequent pass.