fix(docs): broken links and style, deleted command code from MD file

projectcapsule · Nov 6, 2021 · 0aeaf89 · 0aeaf89
1 parent 3d31ddb
commit 0aeaf89
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 25 deletions.
diff --git a/docs/content/operator/managed-kubernetes/overview.md b/docs/content/operator/managed-kubernetes/overview.md
@@ -9,7 +9,7 @@ Capsule Operator can be easily installed on a Managed Kubernetes Service. Since
     - MutatingAdmissionWebhook
     - ValidatingAdmissionWebhook
 
-* [AWS EKS](/docs/managed-kubernetes/aws-eks)
+* [AWS EKS](/docs/operator/managed-kubernetes/aws-eks)
 * CoAKS - Capsule over Azure Kubernetes Service
 * Google Cloud GKE
 * IBM Cloud

diff --git a/docs/content/operator/references.md b/docs/content/operator/references.md
@@ -13,7 +13,7 @@ Capsule operator uses a Custom Resources Definition (CRD) for _Tenants_. In Caps
 
 You can learn about tenant CRD by the `kubectl explain` command:
 
-```command
+```
 kubectl explain tenant
 
 KIND:     Tenant
@@ -44,7 +44,7 @@ FIELDS:
 
 For Tenant spec:
 
-```command
+```
 kubectl explain tenant.spec
 
 KIND:     Tenant
@@ -124,7 +124,7 @@ FIELDS:
 
 and Tenant status:
 
-```command
+```
 kubectl explain tenant.status
 KIND:     Tenant
 VERSION:  capsule.clastix.io/v1beta1

diff --git a/docs/content/operator/use-cases/overview.md b/docs/content/operator/use-cases/overview.md
@@ -43,7 +43,7 @@ Use Capsule to address any of the following scenarios:
 * [Allow adding labels and annotations on namespaces](/docs/operator/use-cases/namespace-labels-and-annotations)
 * [Velero Backup Restoration](/docs/operator/use-cases/velero-backup-restoration)
 * [Deny Wildcard Hostnames](/docs/operator/use-cases/deny-wildcard-hostnames)
-* [Denying specific user-defined labels or annotations on Nodes](/docs/operator/use-cases/deny-specific-user-defined-labels-or-annotations-on-nodes)
+* [Denying specific user-defined labels or annotations on Nodes](/docs/operator/use-cases/node-labels-and-annotations)
 
 > NB: as we improve Capsule, more use cases about multi-tenancy and cluster governance will be covered.
 

diff --git a/docs/gridsome.server.js b/docs/gridsome.server.js
@@ -23,11 +23,7 @@ module.exports = function (api) {
             {
               label: 'Dev guide',
               path: '/docs/dev-guide'
-            },
-            {
-              label: 'Contributing',
-              path: '/docs/contributing'
-            },
+            }
           ]
         },
         {

diff --git a/docs/src/components/AppFooter.vue b/docs/src/components/AppFooter.vue
@@ -9,7 +9,7 @@
       "
     >
       <div class="space-y-2">
-        <h1 class="font-bold text-2xl inline-block">Capsule</h1>
+        <h1 class="font-bold text-2xl inline-block">Clastix</h1>
         <small class="block">
           ©{{ new Date().getFullYear() }} All rights reserved
         </small>

diff --git a/docs/src/components/OnThisPage.vue b/docs/src/components/OnThisPage.vue
@@ -1,7 +1,7 @@
 <template>
   <ul class="space-y-2">
     <template v-for="(heading, index) in headings">
-      <li v-if="heading.depth > 1" :key="index" class="hover:underline">
+      <li v-if="heading.depth === 2" :key="index" class="hover:underline">
         <g-link
           :to="`${pagePath}${heading.anchor}`"
           class="text-sm"
@@ -93,7 +93,7 @@ export default {
       });
 
       const elements = document.querySelectorAll(
-        ".content h2, .content h3, .content h4, .content h5, .content h6"
+        ".content h2"
       );
 
       for (let i = 0; i < elements.length; i++) {

diff --git a/docs/src/pages/Index.vue b/docs/src/pages/Index.vue
@@ -72,15 +72,6 @@
               security best practices and meet legal requirements.
             </p>
           </div>
-          <div class="bg-gray-900 bg-opacity-20 p-5 rounded-md shadow-lg">
-            <h2 class="text-xl lg:text-3xl font-semibold mb-2.5">
-              Resources Control
-            </h2>
-            <p class="lg:text-lg">
-              Leverage Kubernetes Admission Controllers to enforce the industry
-              security best practices and meet legal requirements.
-            </p>
-          </div>
           <div class="bg-gray-900 bg-opacity-20 p-5 rounded-md shadow-lg">
             <h2 class="text-xl lg:text-3xl font-semibold mb-2.5">
               Resources Control
@@ -100,6 +91,14 @@
               binaries.
             </p>
           </div>
+          <div class="bg-gray-900 bg-opacity-20 p-5 rounded-md shadow-lg">
+            <h2 class="text-xl lg:text-3xl font-semibold mb-2.5">
+              GitOps ready
+            </h2>
+            <p class="lg:text-lg">
+              Capsule is completely declarative and GitOps ready.
+            </p>
+          </div>
         </div>
       </div>
     </div>
@@ -124,23 +123,26 @@ export default {
       meta: [
         {
           property: "og:title",
-          content: "Capsule Documentation | Capsule: Kubernetes Operator for multi-tenancy",
+          content:
+            "Capsule Documentation | Capsule: Kubernetes Operator for multi-tenancy",
         },
         {
           property: "og:description",
           content: this.$page.metadata.siteDescription,
         },
         {
           property: "og:image",
-          content: 'https://quizzical-roentgen-574926.netlify.app/assets/share.png',
+          content:
+            "https://quizzical-roentgen-574926.netlify.app/assets/share.png",
         },
         {
           property: "twitter:card",
           content: "summary",
         },
         {
           property: "twitter:title",
-          content: "Capsule Documentation | Capsule: Kubernetes Operator for multi-tenancy",
+          content:
+            "Capsule Documentation | Capsule: Kubernetes Operator for multi-tenancy",
         },
         {
           property: "twitter:description",