docs: CNCF onboarding (#236)

* docs: CNCF onboarding Signed-off-by: Bence Csati <bcsati@cisco.com> * docs: style Signed-off-by: Bence Csati <bcsati@cisco.com> docs: style Signed-off-by: Bence Csati <bcsati@cisco.com> --------- Signed-off-by: Bence Csati <bcsati@cisco.com>
bank-vaults · Jul 30, 2024 · 697b990 · 697b990
1 parent 2db62fa
commit 697b990
Show file tree

Hide file tree

Showing 19 changed files with 135 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -9,5 +9,5 @@ contact_links:
     about: Check the documentation for help
 
   - name: 💬 Slack channel
-    url: https://outshift.slack.com/messages/bank-vaults
+    url: https://cloud-native.slack.com/archives/C078PHYK38W
     about: Please ask and answer questions here
diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss
@@ -42,10 +42,34 @@ h3[class*="type-"]::before {
   text-transform: uppercase;
 }
 
+// Main-page specific customizations
 .main-lead {
   line-height: 1.5;
 }
 
+.container {
+  display: flex;
+  flex-direction: column;
+  gap: 20px; /* Space between rows */
+  padding: 20px; /* Optional padding for container */
+}
+.trustedby-row {
+  display: flex;
+  justify-content: center;
+  gap: 20px; /* Space between columns */
+}
+.trustedby-col {
+  flex: 1;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+}
+.trustedby-img {
+  max-width: 80%;
+  height: auto;
+  object-fit: contain; /* Ensure images maintain aspect ratio */
+}
+
 // Match fontsize of sections with code in their titles for CRD reference pages
 .td-content > h4 > em {
 	font-size: 87.5%;

diff --git a/config/_default/config.toml b/config/_default/config.toml
@@ -19,10 +19,11 @@ enableGitInfo = true
 [languages]
 [languages.en]
 title = "Bank-Vaults"
-description = "Documentation for the Bank-Vaults"
 languageName ="English"
 # Weight used for sorting.
 weight = 1
+  [language.en.params]
+    description = "Documentation for the Bank-Vaults"
 
 [outputs]
     home = ["HTML", "print"]
@@ -47,7 +48,7 @@ twitter = "calisti12"
 
   email = "mailto:team@bank-vaults.dev"
 
-  copyright = "Bank-Vaults maintainers"
+  copyright = "Bank-Vaults maintainers | "
 
   relativeURLs = true
 
@@ -70,6 +71,7 @@ twitter = "calisti12"
   # The version number for the version of the docs represented in this doc set.
   # Used in the "version-banner" partial to display a version number for the
   # current doc set.
+
   version = "4.0.0"
   version_menu_canonicallinks = true
 

diff --git a/content/_index.md b/content/_index.md
@@ -36,3 +36,54 @@ In case you need help, you can find us in our Slack channel.
 {{% /blocks/feature %}}
 
 {{< /blocks/section >}}
+
+{{% blocks/lead color="blue" %}}
+<div class="mb-4 h2">
+  Trusted and supported by
+</div>
+<div class="container">
+    <div class="trustedby-row">
+      <div class="trustedby-col">
+        <a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
+          <img src="/adopters/wildlifestudios-logo.webp" alt="Wildlife Studios logo" class="trustedby-img" />
+        </a>
+      </div>
+      <div class="trustedby-col">
+        <a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
+          <img src="/adopters/cisco-logo.webp" alt="Cisco logo" class="trustedby-img" />
+        </a>
+      </div>
+	  <div class="trustedby-col">
+        <a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
+          <img src="/adopters/vonage-logo.webp" alt="Vonage logo" class="trustedby-img" />
+        </a>
+      </div>
+    </div>
+    <div class="trustedby-row">
+      <div class="trustedby-col">
+        <a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
+          <img src="/adopters/triplelift-logo.webp" alt="TripleLift logo" class="trustedby-img" />
+        </a>
+      </div>
+      <div class="trustedby-col">
+        <a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
+          <img src="/adopters/postman-logo.webp" alt="Postman logo" class="trustedby-img" />
+        </a>
+      </div>
+      <div class="trustedby-col">
+        <a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
+          <img src="/adopters/alvaria-logo.webp" alt="Alvaria logo" class="trustedby-img" />
+        </a>
+      </div>
+    </div>
+</div>
+
+{{% /blocks/lead %}}
+
+{{% blocks/lead color="dark" %}}
+<div class="lead-text">
+<p>We are a <a href="https://www.cncf.io/projects/">Cloud Native Computing Foundation sandbox project.</a></p>
+
+<a href="https://www.cncf.io/" target="_blank"><img src="https://raw.githubusercontent.com/cncf/artwork/master/other/cncf/horizontal/white/cncf-white.svg" alt="CNCF banner" width="33%"></img></a>
+</div>
+{{% /blocks/lead %}}
diff --git a/content/docs/_index.md b/content/docs/_index.md
@@ -24,3 +24,7 @@ In addition, we also provide Helm charts for installing various components, as w
 
 - If you are new to **Bank-Vaults**, begin with the [getting started guide]({{<relref "installing">}}).
 - If you need help using Bank-Vaults, see the [Support page]({{< relref "/docs/support.md" >}}) for ways to contact us.
+
+## Support
+
+If you encounter problems while using Bank-Vaults that the documentation does not address, you can [open an issue](https://github.com/bank-vaults/bank-vaults/issues) or write to us on [Slack]({{< relref "/docs/support.md" >}}).
diff --git a/content/docs/community/_index.md b/content/docs/community/_index.md
@@ -5,8 +5,8 @@ weight: 8000
 
 If you have questions about Bank-Vaults or its components, get in touch with us on Slack!
 
-First, [register on the Outshift Slack](https://outshift.com/slack), then [visit our Slack channel](https://outshift.slack.com/messages/bank-vaults).
+First, [register on the CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf), then [visit the #bank-vaults Slack channel](https://cloud-native.slack.com/archives/C078PHYK38W/).
 
-You can also ask questions on [GitHub Discussions](https://github.com/orgs/bank-vaults/discussions). We share important updates also here.
+You can also ask questions on [GitHub Discussions](https://github.com/orgs/bank-vaults/discussions). We also share important updates here.
 
 If you'd like to contribute, see our [contribution guidelines]({{< relref "/docs/contributing.md" >}}) for details.
diff --git a/content/docs/contributing.md b/content/docs/contributing.md
@@ -14,11 +14,11 @@ any real-time space e.g., Slack, Discord, etc.
 Submitting pull requests and code changes is not the only way to contribute:
 
 - If you use Bank-Vaults in a production environment, add yourself to the [adopters list](https://github.com/bank-vaults/bank-vaults/blob/master/ADOPTERS.md).
-- Help new users with issues they may encounter on the GitHub Issues pages of our repositories
-- Participate in discussions in the [#bank-vaults community Slack channel](https://outshift.com/slack) or in [GitHub Discussions](https://github.com/orgs/bank-vaults/discussions)
+- Help new users with issues they may encounter on the GitHub Issues pages of our repositories.
+- Participate in discussions in the [#bank-vaults Slack channel](https://cloud-native.slack.com/archives/C078PHYK38W/) or in [GitHub Discussions](https://github.com/orgs/bank-vaults/discussions).
 - Support the development of this project and [star our GitHub repos](https://github.com/bank-vaults)!
-- Report bugs or request features in [GitHub repos](https://github.com/bank-vaults)
-- Review and update the existing content of our [documentation](https://bank-vaults.dev) with up-to-date instructions and code samples
+- Report bugs or request features in [GitHub repos](https://github.com/bank-vaults).
+- Review and update the existing content of our [documentation](https://bank-vaults.dev) with up-to-date instructions and code samples.
 
 ## Reporting issues
 

diff --git a/content/docs/support.md b/content/docs/support.md
@@ -5,6 +5,6 @@ weight: 1175
 
 ## Community support
 
-If you encounter problems while using Bank-Vaults that the documentation does not address, [open an issue](https://github.com/bank-vaults/) in the repository of the relevant component, or talk to us in the [#bank-vaults channel of the Outshift Community Slack](https://outshift.slack.com/).
+If you encounter problems while using Bank-Vaults that the documentation does not address, you can [open an issue](https://github.com/bank-vaults/) in the repository of the relevant component or talk to us in the [#bank-vaults channel of the CNCF Slack](https://cloud-native.slack.com/archives/C078PHYK38W/).
 
 {{< include-headless "reporting-issues.md" >}}
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
@@ -0,0 +1,9 @@
+<footer class="bg-dark py-5 row d-print-none">
+  <div class="container-fluid mx-sm-5">
+    <div class="row">
+      {{ partial "footer/left.html" . }}
+      {{ partial "footer/center.html" . }}
+      {{ partial "footer/right.html" . }}
+    </div>
+  </div>
+</footer>
diff --git a/layouts/partials/footer/center.html b/layouts/partials/footer/center.html
@@ -0,0 +1,8 @@
+<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
+  {{ $links := .Site.Params.links }}
+  {{ with $links }}
+  {{ with index . "developer"}}
+  {{ template "footer-links-block"  . }}
+  {{ end }}
+  {{ end }}
+</div>
diff --git a/layouts/partials/footer/left.html b/layouts/partials/footer/left.html
@@ -0,0 +1,8 @@
+<div class="col-6 col-sm-4 text-xs-center order-sm-2">
+  {{ $links := .Site.Params.links }}
+  {{ with $links }}
+  {{ with index . "user"}}
+  {{ template "footer-links-block"  . }}
+  {{ end }}
+  {{ end }}
+</div>
diff --git a/layouts/partials/footer/links.html b/layouts/partials/footer/links.html
@@ -0,0 +1,11 @@
+{{ define "footer-links-block" }}
+<ul class="list-inline mb-0">
+  {{ range . }}
+  <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="{{ .name }}" aria-label="{{ .name }}">
+    <a class="text-white" target="_blank" rel="noopener" href="{{ .url }}" aria-label="{{ .name }}">
+      <i class="{{ .icon }}"></i>
+    </a>
+  </li>
+  {{ end }}
+</ul>
+{{ end }}
diff --git a/layouts/partials/footer/right.html b/layouts/partials/footer/right.html
@@ -0,0 +1,8 @@
+<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
+    <small class="text-white"><a class="text-white" href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a> | </small>
+    {{ with .Site.Params.copyright }}<small class="text-white">&copy; {{ now.Year}} {{ .}} {{ T "footer_all_rights_reserved" }}</small>{{ end }}
+    {{ with .Site.Params.privacy_policy }}<small class="ml-1"><a href="{{ . }}" target="_blank" rel="noopener">{{ T "footer_privacy_policy" }}</a></small>{{ end }}
+    {{ if not .Site.Params.ui.footer_about_disable }}
+      {{ with .Site.GetPage "about" }}<p class="mt-2"><a href="{{ .RelPermalink }}">{{ .Title }}</a></p>{{ end }}
+    {{ end }}
+</div>
diff --git a/static/adopters/alvaria-logo.webp b/static/adopters/alvaria-logo.webp
diff --git a/static/adopters/cisco-logo.webp b/static/adopters/cisco-logo.webp
diff --git a/static/adopters/postman-logo.webp b/static/adopters/postman-logo.webp
diff --git a/static/adopters/triplelift-logo.webp b/static/adopters/triplelift-logo.webp
diff --git a/static/adopters/vonage-logo.webp b/static/adopters/vonage-logo.webp
diff --git a/static/adopters/wildlifestudios-logo.webp b/static/adopters/wildlifestudios-logo.webp