Updates to README and documentation

Some TODOs for the adapter and policy documentation Tutorials also need wiping and rewriting for the new version
valocode · Sep 5, 2021 · 417287b · 417287b
1 parent 477b86b
commit 417287b
Show file tree

Hide file tree

Showing 40 changed files with 45,129 additions and 10,808 deletions.
diff --git a/README.md b/README.md
@@ -15,9 +15,11 @@ Bubbly is a release readiness platform helping software teams release compliant
 
 ## Project Status
 
-This project is currently in **ALPHA**
+This project is currently in **Alpha**
 
-This means that it should work, and if it doesn't please raise an issue. The APIs may change in the coming weeks/months.
+In terms of stability, the existing features should work and if they do not please raise an issue. Also we do not guarantee backwards compatability with the APIs and schema.
+
+In terms of feature completeness, we are working on implementing the core features of Bubbly, and hence there are missing features, such as Subscriptions and Monitoring of vulnerabilities.
 
 If you are interested in getting involved in the project, or want some help getting started, please reach out to us though our website: [https://bubbly.dev](https://bubbly.dev)
 
@@ -50,9 +52,10 @@ We are not aiming to replace every tool you are already using, in fact, without
 
 Some ways in which Bubbly could be used are:
 
-* Real-time knowledgebase of all projects, repos and their high-level release readiness state.
+* Collect all relevant release readiness data from your release process (artifacts, test results, Software Bill of Material, etc.).
+* Create a decision protocol to formally define your Release Readiness Policy, and automatically apply that to all projects/repositories.
 * Catalogue of OSS components, licenses, Vulnerabilities and approvals/rejections for those.
-* A decision protocol to formally define your Release Readiness Policy, and automatically apply that to all projects.
+* Help teams develop their continuous practices by profiling the current process to identify bottlenecks and possible performance gains.
 
 If you have some ideas or questions for things you want to solve, please raise an issue in the [Discussion](https://github.com/valocode/bubbly/discussions) and we'll check it out :)
 

diff --git a/docs/docs.go b/docs/docs.go
diff --git a/docs/docs/adapters/adapters.md b/docs/docs/adapters/adapters.md
@@ -0,0 +1,11 @@
+---
+title: Adapters
+hide_title: false
+hide_table_of_contents: false
+keywords:
+- docs
+- bubbly
+- adapters
+---
+
+TODO
diff --git a/docs/docs/api/api.md b/docs/docs/api/api.md
@@ -8,4 +8,9 @@ keywords:
 - api
 ---
 
-Bubbly API documentation is generated by Swagger. [Read Bubbly API documentation](https://api.bubbly.dev/swagger/index.html).
+:::note Under Active Development
+Setting up Open API documentation for Bubbly is a work in progress.
+We will update the documentation when it's available.
+
+In the meantime, check the [GraphQL Docs](../graphql/graphql)
+:::
diff --git a/docs/docs/cli/bubbly-agent.md b/docs/docs/cli/bubbly-agent.md
diff --git a/docs/docs/cli/bubbly-apply.md b/docs/docs/cli/bubbly-apply.md
diff --git a/docs/docs/cli/bubbly-get.md b/docs/docs/cli/bubbly-get.md
diff --git a/docs/docs/cli/bubbly-schema.md b/docs/docs/cli/bubbly-schema.md
diff --git a/docs/docs/cli/bubbly.md b/docs/docs/cli/bubbly.md
@@ -1,32 +1,40 @@
 ---
 title: bubbly
-sidebar_label: bubbly
 hide_title: false
 hide_table_of_contents: false
-description: Bubbly CLI - bubbly
 keywords:
 - docs
 - bubbly
 - cli
-- root
 ---
+## bubbly
 
-bubbly: release readiness in a bubble
+Bubbly - The Release Readiness Platform
 
-Find more information: https://bubbly.dev
+### Synopsis
+
+Bubbly is a release readiness platform helping you
+release software with confidence, continuously.
+
+To learn more visit https://bubbly.dev
+Documentation available at https://docs.bubbly.dev
 
 ### Options
 
 ```
-      --debug         specify whether to enable debug logging
-  -h, --help          help for bubbly
-      --host string   bubbly API server host (default "127.0.0.1")
-      --port string   bubbly API server port (default "8111")
+      --debug      specify whether to enable debug logging
+  -h, --help       help for bubbly
+      --no-color   specify whether to disable colorful logging
+      --test       specify whether to enable debug logging
 ```
 
 ### SEE ALSO
 
-* [bubbly agent](bubbly-agent.md)	 - Start a bubbly agent
-* [bubbly apply](bubbly-apply.md)	 - Apply one or more bubbly resource to a bubbly agent
-* [bubbly get](bubbly-get.md)	 - Display one or many bubbly resources
-* [bubbly schema](bubbly-schema.md)	 - manage your bubbly schema
+* [bubbly adapter](bubbly_adapter.md)	 - Manage bubbly adapters
+* [bubbly demo](bubbly_demo.md)	 - Start the bubbly server in demo mode
+* [bubbly policy](bubbly_policy.md)	 - Manage bubbly policies
+* [bubbly release](bubbly_release.md)	 - Manage bubbly releases
+* [bubbly server](bubbly_server.md)	 - Start the bubbly server
+* [bubbly version](bubbly_version.md)	 - Show the Bubbly version
+
+###### Auto generated by spf13/cobra on 5-Sep-2021