Skip to content

Commit 697b990

Browse files
csatib02csatib02
authored
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>
1 parent 2db62fa commit 697b990

19 files changed

+135
-10
lines changed

‎.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ contact_links:
99
about: Check the documentation for help
1010

1111
- name: 💬 Slack channel
12-
url: https://outshift.slack.com/messages/bank-vaults
12+
url: https://cloud-native.slack.com/archives/C078PHYK38W
1313
about: Please ask and answer questions here

‎assets/scss/_styles_project.scss

+24
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,34 @@ h3[class*="type-"]::before {
4242
text-transform: uppercase;
4343
}
4444

45+
// Main-page specific customizations
4546
.main-lead {
4647
line-height: 1.5;
4748
}
4849

50+
.container {
51+
display: flex;
52+
flex-direction: column;
53+
gap: 20px; /* Space between rows */
54+
padding: 20px; /* Optional padding for container */
55+
}
56+
.trustedby-row {
57+
display: flex;
58+
justify-content: center;
59+
gap: 20px; /* Space between columns */
60+
}
61+
.trustedby-col {
62+
flex: 1;
63+
display: flex;
64+
justify-content: center;
65+
align-items: center;
66+
}
67+
.trustedby-img {
68+
max-width: 80%;
69+
height: auto;
70+
object-fit: contain; /* Ensure images maintain aspect ratio */
71+
}
72+
4973
// Match fontsize of sections with code in their titles for CRD reference pages
5074
.td-content > h4 > em {
5175
font-size: 87.5%;

‎config/_default/config.toml

+4-2
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ enableGitInfo = true
1919
[languages]
2020
[languages.en]
2121
title = "Bank-Vaults"
22-
description = "Documentation for the Bank-Vaults"
2322
languageName ="English"
2423
# Weight used for sorting.
2524
weight = 1
25+
[language.en.params]
26+
description = "Documentation for the Bank-Vaults"
2627

2728
[outputs]
2829
home = ["HTML", "print"]
@@ -47,7 +48,7 @@ twitter = "calisti12"
4748

4849
email = "mailto:team@bank-vaults.dev"
4950

50-
copyright = "Bank-Vaults maintainers"
51+
copyright = "Bank-Vaults maintainers | "
5152

5253
relativeURLs = true
5354

@@ -70,6 +71,7 @@ twitter = "calisti12"
7071
# The version number for the version of the docs represented in this doc set.
7172
# Used in the "version-banner" partial to display a version number for the
7273
# current doc set.
74+
7375
version = "4.0.0"
7476
version_menu_canonicallinks = true
7577

‎content/_index.md

+51
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,54 @@ In case you need help, you can find us in our Slack channel.
3636
{{% /blocks/feature %}}
3737

3838
{{< /blocks/section >}}
39+
40+
{{% blocks/lead color="blue" %}}
41+
<div class="mb-4 h2">
42+
Trusted and supported by
43+
</div>
44+
<div class="container">
45+
<div class="trustedby-row">
46+
<div class="trustedby-col">
47+
<a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
48+
<img src="/adopters/wildlifestudios-logo.webp" alt="Wildlife Studios logo" class="trustedby-img" />
49+
</a>
50+
</div>
51+
<div class="trustedby-col">
52+
<a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
53+
<img src="/adopters/cisco-logo.webp" alt="Cisco logo" class="trustedby-img" />
54+
</a>
55+
</div>
56+
<div class="trustedby-col">
57+
<a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
58+
<img src="/adopters/vonage-logo.webp" alt="Vonage logo" class="trustedby-img" />
59+
</a>
60+
</div>
61+
</div>
62+
<div class="trustedby-row">
63+
<div class="trustedby-col">
64+
<a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
65+
<img src="/adopters/triplelift-logo.webp" alt="TripleLift logo" class="trustedby-img" />
66+
</a>
67+
</div>
68+
<div class="trustedby-col">
69+
<a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
70+
<img src="/adopters/postman-logo.webp" alt="Postman logo" class="trustedby-img" />
71+
</a>
72+
</div>
73+
<div class="trustedby-col">
74+
<a href="https://github.com/bank-vaults/bank-vaults/blob/main/ADOPTERS.md">
75+
<img src="/adopters/alvaria-logo.webp" alt="Alvaria logo" class="trustedby-img" />
76+
</a>
77+
</div>
78+
</div>
79+
</div>
80+
81+
{{% /blocks/lead %}}
82+
83+
{{% blocks/lead color="dark" %}}
84+
<div class="lead-text">
85+
<p>We are a <a href="https://www.cncf.io/projects/">Cloud Native Computing Foundation sandbox project.</a></p>
86+
87+
<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>
88+
</div>
89+
{{% /blocks/lead %}}

‎content/docs/_index.md

+4
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ In addition, we also provide Helm charts for installing various components, as w
2424

2525
- If you are new to **Bank-Vaults**, begin with the [getting started guide]({{<relref "installing">}}).
2626
- If you need help using Bank-Vaults, see the [Support page]({{< relref "/docs/support.md" >}}) for ways to contact us.
27+
28+
## Support
29+
30+
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" >}}).

‎content/docs/community/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ weight: 8000
55

66
If you have questions about Bank-Vaults or its components, get in touch with us on Slack!
77

8-
First, [register on the Outshift Slack](https://outshift.com/slack), then [visit our Slack channel](https://outshift.slack.com/messages/bank-vaults).
8+
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/).
99

10-
You can also ask questions on [GitHub Discussions](https://github.com/orgs/bank-vaults/discussions). We share important updates also here.
10+
You can also ask questions on [GitHub Discussions](https://github.com/orgs/bank-vaults/discussions). We also share important updates here.
1111

1212
If you'd like to contribute, see our [contribution guidelines]({{< relref "/docs/contributing.md" >}}) for details.

‎content/docs/contributing.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ any real-time space e.g., Slack, Discord, etc.
1414
Submitting pull requests and code changes is not the only way to contribute:
1515

1616
- 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).
17-
- Help new users with issues they may encounter on the GitHub Issues pages of our repositories
18-
- 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)
17+
- Help new users with issues they may encounter on the GitHub Issues pages of our repositories.
18+
- 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).
1919
- Support the development of this project and [star our GitHub repos](https://github.com/bank-vaults)!
20-
- Report bugs or request features in [GitHub repos](https://github.com/bank-vaults)
21-
- Review and update the existing content of our [documentation](https://bank-vaults.dev) with up-to-date instructions and code samples
20+
- Report bugs or request features in [GitHub repos](https://github.com/bank-vaults).
21+
- Review and update the existing content of our [documentation](https://bank-vaults.dev) with up-to-date instructions and code samples.
2222

2323
## Reporting issues
2424

‎content/docs/support.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ weight: 1175
55

66
## Community support
77

8-
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/).
8+
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/).
99

1010
{{< include-headless "reporting-issues.md" >}}

‎layouts/partials/footer.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<footer class="bg-dark py-5 row d-print-none">
2+
<div class="container-fluid mx-sm-5">
3+
<div class="row">
4+
{{ partial "footer/left.html" . }}
5+
{{ partial "footer/center.html" . }}
6+
{{ partial "footer/right.html" . }}
7+
</div>
8+
</div>
9+
</footer>

‎layouts/partials/footer/center.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
2+
{{ $links := .Site.Params.links }}
3+
{{ with $links }}
4+
{{ with index . "developer"}}
5+
{{ template "footer-links-block" . }}
6+
{{ end }}
7+
{{ end }}
8+
</div>

‎layouts/partials/footer/left.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<div class="col-6 col-sm-4 text-xs-center order-sm-2">
2+
{{ $links := .Site.Params.links }}
3+
{{ with $links }}
4+
{{ with index . "user"}}
5+
{{ template "footer-links-block" . }}
6+
{{ end }}
7+
{{ end }}
8+
</div>

‎layouts/partials/footer/links.html

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{{ define "footer-links-block" }}
2+
<ul class="list-inline mb-0">
3+
{{ range . }}
4+
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="{{ .name }}" aria-label="{{ .name }}">
5+
<a class="text-white" target="_blank" rel="noopener" href="{{ .url }}" aria-label="{{ .name }}">
6+
<i class="{{ .icon }}"></i>
7+
</a>
8+
</li>
9+
{{ end }}
10+
</ul>
11+
{{ end }}

‎layouts/partials/footer/right.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
2+
<small class="text-white"><a class="text-white" href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a> | </small>
3+
{{ with .Site.Params.copyright }}<small class="text-white">&copy; {{ now.Year}} {{ .}} {{ T "footer_all_rights_reserved" }}</small>{{ end }}
4+
{{ with .Site.Params.privacy_policy }}<small class="ml-1"><a href="{{ . }}" target="_blank" rel="noopener">{{ T "footer_privacy_policy" }}</a></small>{{ end }}
5+
{{ if not .Site.Params.ui.footer_about_disable }}
6+
{{ with .Site.GetPage "about" }}<p class="mt-2"><a href="{{ .RelPermalink }}">{{ .Title }}</a></p>{{ end }}
7+
{{ end }}
8+
</div>

‎static/adopters/alvaria-logo.webp

8.28 KB
Binary file not shown.

‎static/adopters/cisco-logo.webp

9.79 KB
Binary file not shown.

‎static/adopters/postman-logo.webp

21.2 KB
Binary file not shown.

‎static/adopters/triplelift-logo.webp

20.9 KB
Binary file not shown.

‎static/adopters/vonage-logo.webp

64.8 KB
Binary file not shown.

‎static/adopters/wildlifestudios-logo.webp

8.27 KB
Binary file not shown.

0 commit comments

Comments
 (0)