Merge pull request #582 from killbill/premium-fixes-2

Premium fixes 2
killbill · Dec 9, 2024 · fa19b24 · fa19b24
2 parents 1b2ff00 + 135e3a5
commit fa19b24
Show file tree

Hide file tree

Showing 3 changed files with 137 additions and 107 deletions.
diff --git a/html5/_main_toc.html.slim b/html5/_main_toc.html.slim
@@ -2,7 +2,8 @@ nav.sidebar-nav
   ul.nav.navbar-nav
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Getting Started
+        a.bd-toc-link.main-link role="button"
+          | Getting Started
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -20,9 +21,14 @@ nav.sidebar-nav
         li
           a.nav-link href="/latest/quick_start_with_kb_api.html"
             | Quick Start with the Kill Bill API
+        li
+          a.nav-link href="/latest/premium_features.html"
+            | Premium Capabilities
+            span.dot style="background-color: #7C3AE3;"
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Installation
+        a.bd-toc-link.main-link role="button"
+          | Installation
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -45,87 +51,8 @@ nav.sidebar-nav
             | Notes
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" AWS
-        <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
-          <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
-        </svg>
-      ul.nav.navbar-nav
-        li.bd-sidenav-active
-          a.nav-link href="/latest/aws.html"
-            | AWS Introduction
-        li
-          a.nav-link href="/latest/how-to-set-up-a-single-tier-system.html"
-            | Single-Tier Setup
-        li
-          a.nav-link href="/latest/how-to-set-up-a-multi-tier-system.html"
-            | Multi-Tier Setup
-        li
-          a.nav-link href="/latest/how-to-set-up-a-cloud-formation-system.html"
-            | CloudFormation Setup
-        li
-          a.nav-link href="/latest/aws-container.html"
-            | AWS Container Setup
-        li
-          a.nav-link href="/latest/how-to-maintain-a-single-tier-system.html"
-            | Single-Tier Maintenance
-        li
-          a.nav-link href="/latest/how-to-maintain-a-multi-tier-system.html"
-            | Multi-Tier Maintenance
-        li
-          a.nav-link href="/latest/how-to-maintain-a-cloud-formation-system.html"
-            | CloudFormation Maintenance
-        li
-          a.nav-link href="/latest/explanation-https-and-certificates.html"
-            | HTTPS and Certificates
-        li
-          a.nav-link href="/latest/how-to-add-a-certificate-using-ACM.html"
-            | How to add a certificate using ACM
-        li
-          a.nav-link href="/latest/using-ses-with-aws.html"
-            | Using SES with AWS
-        li
-          a.nav-link href="/latest/events-to-aws-sqs.html"
-            | Kill Bill Events to AWS SQS
-        li
-          a.nav-link href="/latest/aws-tools.html"
-            | AWS Observability Tools
-        li
-          a.nav-link href="/latest/metrics-datadog.html"
-            | Managing Metrics with Datadog
-        li
-          a.nav-link href="/latest/metrics-newrelic.html"
-            | Managing Metrics with New Relic
-        li
-          a.nav-link href="/latest/metrics-cloudwatch.html"
-            | Managing Metrics with Cloudwatch
-        li
-          a.nav-link href="/latest/errors-rollbar.html"
-            | Error Tracking with Rollbar
-        li
-          a.nav-link href="/latest/errors-sentry.html"
-            | Error Tracking with Sentry
-    li
-          .icon-title
-            a.bd-toc-link.main-link role="button" Aviate
-            <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
-              <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
-            </svg>
-          ul.nav.navbar-nav
-            li
-              a.nav-link href="/latest/what_is_aviate.html"
-                | What is Aviate?                                    
-            li.bd-sidenav-active
-              a.nav-link href="/latest/aviate-catalog-plugin.html"
-                | Aviate Catalog Plugin
-            li.bd-sidenav-active
-              a.nav-link href="/latest/how-to-install-the-aviate-plugin.html"
-                | Aviate Plugin Installation
-            li.bd-sidenav-active
-              a.nav-link href="/latest/aviate-health.html"
-                | Aviate Health
-    li
-      .icon-title
-        a.bd-toc-link.main-link role="button" Manuals
+        a.bd-toc-link.main-link role="button"
+          | Manuals
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -163,7 +90,8 @@ nav.sidebar-nav
             | Migrating to Kill Bill
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Tutorials
+        a.bd-toc-link.main-link role="button"
+          | Tutorials
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -192,7 +120,8 @@ nav.sidebar-nav
             | Invoice Templates
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Integration
+        a.bd-toc-link.main-link role="button"
+          | Integration
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -218,25 +147,10 @@ nav.sidebar-nav
         li
           a.nav-link href="/latest/how-to-use-kpm-diagnostic.html"
             | KPM Diagnostic Usage
-    / li
-    /   .icon-title
-    /     a.bd-toc-link.main-link role="button" Aviate
-    /     <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
-    /       <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
-    /     </svg>
-    /   ul.nav.navbar-nav
-    /     li.bd-sidenav-active
-    /       a.nav-link href="/latest/aviate-catalog.html"
-    /         | Catalog
-    /     li
-    /       a.nav-link href="/latest/aviate-health.html"
-    /         | Health
-    /     li
-    /       a.nav-link href="/latest/aviate-metering.html"
-    /         | Metering
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Plugin Development
+        a.bd-toc-link.main-link role="button"
+          | Plugin Development
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -276,7 +190,8 @@ nav.sidebar-nav
             | Entitlement Plugins
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Operational Guides
+        a.bd-toc-link.main-link role="button"
+          | Operational Guides
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -293,7 +208,8 @@ nav.sidebar-nav
 
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Client Libraries
+        a.bd-toc-link.main-link role="button"
+          | Client Libraries
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -318,7 +234,8 @@ nav.sidebar-nav
             | KillBill Go 
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" About Kill Bill
+        a.bd-toc-link.main-link role="button"
+          | About Kill Bill
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -337,7 +254,8 @@ nav.sidebar-nav
             | Glossary
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" Internal
+        a.bd-toc-link.main-link role="button"
+          | Internal
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>
@@ -356,7 +274,92 @@ nav.sidebar-nav
             | Development Environment
     li
       .icon-title
-        a.bd-toc-link.main-link role="button" References
+        a.bd-toc-link.main-link role="button"
+          | AWS
+          span.dot style="background-color: #7C3AE3;"          
+        <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
+          <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
+        </svg>
+      ul.nav.navbar-nav
+        li.bd-sidenav-active
+          a.nav-link href="/latest/aws.html"
+            | AWS Introduction
+        li
+          a.nav-link href="/latest/how-to-set-up-a-single-tier-system.html"
+            | Single-Tier Setup
+        li
+          a.nav-link href="/latest/how-to-set-up-a-multi-tier-system.html"
+            | Multi-Tier Setup
+        li
+          a.nav-link href="/latest/how-to-set-up-a-cloud-formation-system.html"
+            | CloudFormation Setup
+        li
+          a.nav-link href="/latest/aws-container.html"
+            | AWS Container Setup
+        li
+          a.nav-link href="/latest/how-to-maintain-a-single-tier-system.html"
+            | Single-Tier Maintenance
+        li
+          a.nav-link href="/latest/how-to-maintain-a-multi-tier-system.html"
+            | Multi-Tier Maintenance
+        li
+          a.nav-link href="/latest/how-to-maintain-a-cloud-formation-system.html"
+            | CloudFormation Maintenance
+        li
+          a.nav-link href="/latest/explanation-https-and-certificates.html"
+            | HTTPS and Certificates
+        li
+          a.nav-link href="/latest/how-to-add-a-certificate-using-ACM.html"
+            | How to add a certificate using ACM
+        li
+          a.nav-link href="/latest/using-ses-with-aws.html"
+            | Using SES with AWS
+        li
+          a.nav-link href="/latest/events-to-aws-sqs.html"
+            | Kill Bill Events to AWS SQS
+        li
+          a.nav-link href="/latest/aws-tools.html"
+            | AWS Observability Tools
+        li
+          a.nav-link href="/latest/metrics-datadog.html"
+            | Managing Metrics with Datadog
+        li
+          a.nav-link href="/latest/metrics-newrelic.html"
+            | Managing Metrics with New Relic
+        li
+          a.nav-link href="/latest/metrics-cloudwatch.html"
+            | Managing Metrics with Cloudwatch
+        li
+          a.nav-link href="/latest/errors-rollbar.html"
+            | Error Tracking with Rollbar
+        li
+          a.nav-link href="/latest/errors-sentry.html"
+            | Error Tracking with Sentry
+    li
+          .icon-title
+            a.bd-toc-link.main-link role="button"
+              | Aviate
+              span.dot style="background-color: #7C3AE3;"
+            <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
+              <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
+            </svg>
+          ul.nav.navbar-nav
+            li
+              a.nav-link href="/latest/what_is_aviate.html"
+                | What is Aviate?                                    
+            li.bd-sidenav-active
+              a.nav-link href="/latest/how-to-install-the-aviate-plugin.html"
+                | Aviate Plugin Installation
+            li.bd-sidenav-active
+              a.nav-link href="/latest/aviate-catalog-plugin.html"
+                | Aviate Catalog
+            li.bd-sidenav-active
+              a.nav-link href="/latest/aviate-health.html"
+                | Aviate Health
+    li    
+      .icon-title
+        a.bd-toc-link.main-link role="button"
+          | References
         <svg class="chevron" width="11" height="6" viewBox="0 0 11 6" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path fill-rule="evenodd" clip-rule="evenodd" d="M10.5024 5.70711C10.1119 6.09763 9.47871 6.09763 9.08818 5.70711L5.7953 2.41421L2.50241 5.70711C2.11188 6.09763 1.47872 6.09763 1.0882 5.70711C0.697672 5.31658 0.697672 4.68342 1.0882 4.29289L5.08819 0.292893C5.47871 -0.0976311 6.11188 -0.0976311 6.5024 0.292893L10.5024 4.29289C10.8929 4.68342 10.8929 5.31658 10.5024 5.70711Z" fill="#D1D5DB"/>
         </svg>

diff --git a/stylesheets/kb.css b/stylesheets/kb.css
@@ -1693,3 +1693,11 @@ input:checked + .slider:before {
 	width: 100%;
 	height: 100%;
 }
+
+span.dot {
+  display: inline-block;
+  width: 8px;
+  height: 8px;
+  margin-left: 5px;
+  border-radius: 50%;
+}
diff --git a/userguide/getting-started/premium_features.adoc b/userguide/getting-started/premium_features.adoc
@@ -0,0 +1,19 @@
+= Premium Capabilities
+
+== Introduction
+
+In addition to the core open-source Kill Bill platform, we also offer additional software packages to make it easier to deploy, operate and administer the system; we also provide additional features that go beyond the set of core subscription billing functionalities offered by the Kill Bill platform. Such premium capabilties are optional, and it is entirely possible to use the open-source Kill Bill platform at scale to address the most complex billing problems. The premium capabilities will however provide an easier experience and add further capabilties that go beyond core subscription billing.
+
+Documentation around premium features will be flagged with a purple dot in the table of content as seen on this page to make it obvious for the reader. 
+
+== AWS Images
+
+We provide a series of AMIs that are tightly integrated with AWS and that make it easy to deploy Kill Bill in a cloud native environment. All our documentation supporting the use of these AMIs will have a banner specifying this is an AWS Marketplace only feature.
+
+== Aviate
+
+We provide a custom plugin to make it easier to administer the system and to also provide additional capabilities not included in the open-source solution. All our documentation supporting our Aviate plugin will have a banner specifying is an Aviate-only feature.
+
+
+
+