GITBOOK-3: No subject

runwhen-contrib · Jan 15, 2024 · ced7e4b · ced7e4b
1 parent 48b33d1
commit ced7e4b
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 22 deletions.
diff --git a/docs/.gitbook/assets/RW_Authors_Asset.png b/docs/.gitbook/assets/RW_Authors_Asset.png
diff --git a/docs/.gitbook/assets/Screenshot from 2024-01-15 07-53-41.png b/docs/.gitbook/assets/Screenshot from 2024-01-15 07-53-41.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,14 +1,14 @@
 # Introduction
 
-<figure><img src="../.gitbook/assets/RW_Authors_Asset.png" alt=""><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/RW_Authors_Asset.png" alt=""><figcaption></figcaption></figure>
 
 At the heart of our platform and [FOSS](https://en.wikipedia.org/wiki/Free\_and\_open-source\_software) offerings is our community of authors. They play a critical role in curating open source collections of troubleshooting commands that the community can either use directly, through [RunWhen Local](https://docs.runwhen.com/public/runwhen-local/introduction-runwhen-local), or on our [platform](https://docs.runwhen.com/public/runwhen-platform/getting-started-with-runwhen-platform) with AI assistants. Our goal is to build the world’s largest open collection of operational code with a level of testing, documentation and metadata that will surpass the libraries at hyperscale companies. It's incredibly challenging - if not impossible - to replicate these multi-thousand person efforts within most companies… but an open source community can.
 
 If any of this sounds interesting to you we'd be excited to have you in the community. Below you'll find a glossary of terms and resources to get started as an author, as well as some details on our rewards program.
 
 If you have any questions feel free to reach out to our team, or email the lead author at [jonathan.funk@runwhen.com](mailto:jonathan.funk@runwhen.com)
 
-<figure><img src="../.gitbook/assets/Screenshot 2023-08-10 135428 (1).png" alt=""><figcaption><p>Author CodeCollection Flow Overview</p></figcaption></figure>
+<figure><img src=".gitbook/assets/Screenshot from 2024-01-15 07-53-41.png" alt=""><figcaption><p>Author CodeCollection Flow Overview</p></figcaption></figure>
 
 ### CodeCollections
 
@@ -29,8 +29,3 @@ We'd love to collaborate and have you be a part of our community. To get started
 ### Communication
 
 For communicating with us, feel free to join and reach out to us on our public [slack](https://runwhen.slack.com/), [discord](https://discord.gg/Ut7Ws4rm8Q) or join the [discussions](https://github.com/orgs/runwhen-contrib/discussions) here!
-
-
-
-
-
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -5,15 +5,13 @@
 ## Codecollection Development
 
 * [Prerequisites](prerequisites.md)
-* [Getting Started](getting-started/)
-* Developer Resources
-    * [Start Samples](starter-samples/README.md)
-    * [Sandbox / Lab Resources](sandbox-resources/README.md)
-
+* [Getting Started](codecollection-development/getting-started.md)
+* [Developer Resources](codecollection-development/developer-resources/README.md)
+  * [Start Samples](starter-samples/README.md)
+  * [Sandbox / Lab Resources](sandbox-resources/README.md)
 
 ## Codecollection Author Program Details
 
 * [Author Rewards](author-rewards.md)
 * [Code of Conduct](code-of-conduct.md)
 * [Contributing](contributing.md)
-
diff --git a/docs/codecollection-development/developer-resources/README.md b/docs/codecollection-development/developer-resources/README.md
@@ -0,0 +1,2 @@
+# Developer Resources
+
diff --git a/docs/codecollection-development/getting-started.md b/docs/codecollection-development/getting-started.md
@@ -0,0 +1,2 @@
+# Getting Started
+
diff --git a/docs/sandbox-resources/README.md b/docs/sandbox-resources/README.md
@@ -4,17 +4,17 @@ description: >-
   same infrastructure that RunWhen uses for testing and demos.
 ---
 
-# Sandbox Resources
+# Sandbox / Lab Resources
 
 ## Sandbox Cluster
 
-RunWhen operates a sandbox GKE cluster that is used for testing and demonstration purposes. For codebundle authors, RunWhen provides access to this cluster to ease the burden on setting up test infrastructure.&#x20;
+RunWhen operates a sandbox GKE cluster that is used for testing and demonstration purposes. For codebundle authors, RunWhen provides access to this cluster to ease the burden on setting up test infrastructure.
 
 ## Application/Infrastructure Stacks
 
-The Sandbox cluster provides many different application stacks, and also continually hosts a demo version of [Broken link](broken-reference "mention") - which provides some insight as to what is running in the cluster (see [here](https://runwhen-local.sandbox.runwhen.com/)).&#x20;
+The Sandbox cluster provides many different application stacks, and also continually hosts a demo version of [broken-reference](broken-reference/ "mention") - which provides some insight as to what is running in the cluster (see [here](https://runwhen-local.sandbox.runwhen.com/)).
 
-Some of the resources include:&#x20;
+Some of the resources include:
 
 * ArgoCD
 * Artifactory
@@ -25,7 +25,7 @@ Some of the resources include:&#x20;
 * Ingress - Kong
 * Ingress - Nginx
 * Jenkins (Traditional)
-* [jenkinsx.md](jenkinsx.md "mention")
+* [Broken link](broken-reference "mention")
 * MongoDB (Operator and test database)
 * Online Boutique
 * Otel-Demo
@@ -34,13 +34,12 @@ Some of the resources include:&#x20;
 
 ### Obtaining Sandbox Access
 
-Access to the sandbox cluster is provided by a shared kubeconfig. Reach out via [Slack](https://runwhen.slack.com/join/shared\_invite/zt-1l7t3tdzl-IzB8gXDsWtHkT8C5nufm2A#/shared-invite/email) or [Discord](https://discord.com/invite/Ut7Ws4rm8Q) to connect with us for read-only access to the cluster.&#x20;
+Access to the sandbox cluster is provided by a shared kubeconfig. Reach out via [Slack](https://runwhen.slack.com/join/shared\_invite/zt-1l7t3tdzl-IzB8gXDsWtHkT8C5nufm2A#/shared-invite/email) or [Discord](https://discord.com/invite/Ut7Ws4rm8Q) to connect with us for read-only access to the cluster.
 
 {% hint style="info" %}
-A dedicated sandbox Vault instance is coming soon for sharing secrets / credentials with codebundle authors.&#x20;
+A dedicated sandbox Vault instance is coming soon for sharing secrets / credentials with codebundle authors.
 {% endhint %}
 
 ### Requesting Additional Application Stacks
 
-Want to write a new codebundle for an application stack that is missing from the Sandbox? Reach out via [Slack](https://runwhen.slack.com/join/shared\_invite/zt-1l7t3tdzl-IzB8gXDsWtHkT8C5nufm2A#/shared-invite/email) or [Discord](https://discord.com/invite/Ut7Ws4rm8Q) to connect with us and we can help. .&#x20;
-
+Want to write a new codebundle for an application stack that is missing from the Sandbox? Reach out via [Slack](https://runwhen.slack.com/join/shared\_invite/zt-1l7t3tdzl-IzB8gXDsWtHkT8C5nufm2A#/shared-invite/email) or [Discord](https://discord.com/invite/Ut7Ws4rm8Q) to connect with us and we can help. .