Skip to content

Commit

Permalink
Merge pull request #151 from vmware-tanzu/feature/doc-update
Browse files Browse the repository at this point in the history
one last push before I yeet to the mountains
  • Loading branch information
v0lkan authored Aug 5, 2023
2 parents 93c8840 + c40f6d6 commit ae308b4
Show file tree
Hide file tree
Showing 13 changed files with 200 additions and 84 deletions.
34 changes: 34 additions & 0 deletions community/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Community

```text
| Protect your secrets, protect your sensitive data.
: Explore VMware Secrets Manager docs at https://vsecm.com/
</
<>/ keep your secrets… secret
```

Welcome to the **VMware Secrets Manager** for Cloud-Native Apps community 🎉.

Here, you will find information about project meetings, and other important
community information.


## VMware Secrets Manager Public Meetings

### VSecM Contributor Sync

* **Date/Time**: Every last Thursday on every month @ 08:00am Pacific
* [**Calendar ICS**](https://calendar.google.com/calendar/ical/0ef770e47ae11cea2b00a743eed3812768cc3f9c2a45fee6207f4c9c8b0dc5ce%40group.calendar.google.com/public/basic.ics)
* [**Meetings Notes**](https://docs.google.com/document/d/19Al-IEEdvrcted9HdXCYyiHRCJSJs2Di9uYPZ_ssygs)

#### Goals

* Discuss **VMware Secrets Manager** project direction and roadmap.
* Provide a high-bandwidth forum in which the community can voice needs and make proposals.
* Achieve maintainer consensus on architectural decisions related to major
**VMware Secrets Manager** features.

#### Non-Goals

* **VMware Secrets Manager** maintenance.
* Triaging, troubleshooting, and resolving issues.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
title: VMWare Secrets Manager for Cloud-Native Apps
layout: post
permalink: /
next_url: /docs/navigation/
next_url: /docs/community/
prev_url: /docs/showcase/
---

Expand Down
6 changes: 5 additions & 1 deletion docs/_includes/toc-date.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@
{% if post.url contains "release-management" %}
<li class="divider"></li>
{% endif %}
{% if post.url contains "changelog" %}
<li class="divider"></li>
{% endif %}



{% if page.url == post.url %}
{% if page.url == post.url %}
<li class="chapter active" data-level="1.2" data-path="{{site.baseurl}}{{post.url}}">
{% else %}
<li class="chapter" data-level="1.1" data-path="{{site.baseurl}}{{post.url}}">
Expand Down
76 changes: 76 additions & 0 deletions docs/_pages/0000-community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
# /*
# | Protect your secrets, protect your sensitive data.
# : Explore VMware Secrets Manager docs at https://vsecm.com/
# </
# <>/ keep your secrets… secret
# >/
# <>/' Copyright 2023–present VMware, Inc.
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

title: Community
layout: post
next_url: /docs/navigation/
prev_url: /
permalink: /docs/community/
---

<p class="github-button"
><a href="https://github.com/vmware-tanzu/secrets-manager/blob/main/docs/_pages/0040-contact.md"
>edit this page on <strong>GitHub</strong> ✏️</a></p>
> **Hi 👋**
>
> Thank you for wanting to be part of the community ❤️.
>
> This page outlines various community events and communication channels.
{: .block-tip}

## Join Our Community on Slack

Open Source is better together.

[**Join VMware Secret Manager’s Slack Workspace**][slack]
and let us change the world together 🤘.

As a, small, dedicated team of security enthusiasts, we value focused, effective
communication. Thus, we prefer to consolidate our interactions into a single
channel, rather than dispersing them across multiple platforms.

## Join Our Public Meetings

> **We Are Stronger Together**
>
> **VMware Secrets Manager** meetings are open for everyone, you are more than
> welcome to join.
{: .block-tip}

### VSecM Contributor Sync

* **Date/Time**: Every last Thursday on every month @ 08:00am Pacific
* [**Calendar ICS**](https://calendar.google.com/calendar/ical/0ef770e47ae11cea2b00a743eed3812768cc3f9c2a45fee6207f4c9c8b0dc5ce%40group.calendar.google.com/public/basic.ics)
* [**Meetings Notes**](https://docs.google.com/document/d/19Al-IEEdvrcted9HdXCYyiHRCJSJs2Di9uYPZ_ssygs)
* [**Zoom Meeting**](https://us06web.zoom.us/j/82734769083?pwd=NDJBR2RIZjR6KzhhK2pNL1ZsRzRJZz09)

#### Goals

* Discuss **VMware Secrets Manager** project direction and roadmap.
* Provide a high-bandwidth forum in which the community can voice needs and make proposals.
* Achieve maintainer consensus on architectural decisions related to major
**VMware Secrets Manager** features.

#### Non-Goals

* **VMware Secrets Manager** maintenance.
* Triaging, troubleshooting, and resolving issues.

[contributing]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CODE_OF_CONDUCT.md

## Thank You ❤️

Thanks so much for your interest: It means a lot 🙏.

[ticket]: https://github.com/vmware-tanzu/secrets-manager/issues/new/choose
[slack]: https://join.slack.com/t/a-101-103-105-s/shared_invite/zt-1zrr2yepf-2P3EJhfoGNn05l5_4jvYSA "Join VSecM Slack"
140 changes: 68 additions & 72 deletions docs/_pages/0040-contact.md → docs/_pages/0001-contact.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,69 @@
---
# /*
# | Protect your secrets, protect your sensitive data.
# : Explore VMware Secrets Manager docs at https://vsecm.com/
# </
# <>/ keep your secrets… secret
# >/
# <>/' Copyright 2023–present VMware, Inc.
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

title: Contact & Community
layout: post
permalink: /docs/community/
prev_url: /docs/endorsements/
next_url: /docs/quickstart/
---

<p class="github-button"
><a href="https://github.com/vmware-tanzu/secrets-manager/blob/main/docs/_pages/0040-contact.md"
>edit this page on <strong>GitHub</strong> ✏️</a></p>
> **Hi 👋**
>
> Thank you for wanting to contact us ❤️.
>
> This page outlines the various ways you can touch base.
## Join Our Community on Slack

As a, small, dedicated team of security enthusiasts, we value focused, effective
communication. Thus, we prefer to consolidate our interactions into a single
channel, rather than dispersing them across multiple platforms.

Open Source is better together. [**Join VMware Secret Manager’s Slack Workspace**][slack]
and let us change the world together 🤘.

## Want to Create an Issue?

In addition to [**Slack**][slack], you can [**create an issue on GitHub**][ticket]
to report a bug, request a feature, or ask a question.

Also, please discuss your idea and findings with the community on
[**VSecM**’s Slack workspace][slack] whenever possible.

## Want to Report a Vulnerability?

If you have found a security vulnerability, please [**follow this guideline**][vuln]
to responsibly disclose it.

[ticket]: https://github.com/vmware-tanzu/secrets-manager/issues/new "Create a new issue"

[vuln]: https://github.com/vmware-tanzu/secrets-manager/blob/main/SECURITY.md
[code-of-conduct]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CODE_OF_CONDUCT.md

## Want to Contribute?

We appreciate your interest in making the world a better and more secure place
where everyone can `#sleepmore` 🤗. We’d love to have you on board.

Please read [the contribution guidelines][contributing] and
[the code of conduct][code-of-conduct], and let us know if you need anything
else.

[contributing]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CODE_OF_CONDUCT.md

## Thank You ❤️

Thanks so much for your interest: It means a lot 🙏.

[ticket]: https://github.com/vmware-tanzu/secrets-manager/issues/new/choose
---
# /*
# | Protect your secrets, protect your sensitive data.
# : Explore VMware Secrets Manager docs at https://vsecm.com/
# </
# <>/ keep your secrets… secret
# >/
# <>/' Copyright 2023–present VMware, Inc.
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

title: Contact
layout: post
next_url: /docs/navigation/
prev_url: /
permalink: /docs/contact/
---

<p class="github-button"
><a href="https://github.com/vmware-tanzu/secrets-manager/blob/main/docs/_pages/0040-contact.md"
>edit this page on <strong>GitHub</strong> ✏️</a></p>
> **Hi 👋**
>
> Thank you for wanting to contact us ❤️.
>
> This page outlines the various ways you can touch base.
## Ask Questions on Slack

[*VMware Secret Manager’s Slack Workspace**][slack] if one of the best ways to
get in touch with the community, ask questions and get help.

## Create a GitHub Issue

In addition to [**Slack**][slack], you can [**create an issue on GitHub**][ticket]
to report a bug, request a feature, or ask a question.

Also, please discuss your idea and findings with the community on
[**VSecM**’s Slack workspace][slack] whenever possible.

## Report a Security Vulnerability

If you have found a security vulnerability, please [**follow this guideline**][vuln]
to responsibly disclose it.

[ticket]: https://github.com/vmware-tanzu/secrets-manager/issues/new "Create a new issue"

[vuln]: https://github.com/vmware-tanzu/secrets-manager/blob/main/SECURITY.md
[code-of-conduct]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CODE_OF_CONDUCT.md

## Contribute to VMware Secrets Manager

We appreciate your interest in making the world a better and more secure place
where everyone can `#sleepmore` 🤗. We’d love to have you on board.

Please read [the contribution guidelines][contributing] and
[the code of conduct][code-of-conduct], and let us know if you need anything
else.

[contributing]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/vmware-tanzu/secrets-manager/blob/main/CODE_OF_CONDUCT.md

## Thank You ❤️

Thanks so much for your interest: It means a lot 🙏.

[ticket]: https://github.com/vmware-tanzu/secrets-manager/issues/new/choose
[slack]: https://join.slack.com/t/a-101-103-105-s/shared_invite/zt-1zrr2yepf-2P3EJhfoGNn05l5_4jvYSA "Join VSecM Slack"
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

title: VSecM Maintainers
title: Maintainers
layout: post
next_url: /docs/navigation/
prev_url: /
next_url: /docs/about/
permalink: /docs/maintainers/
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

title: VSecM Changelog
title: Changelog
layout: post
next_url: /docs/navigation/
prev_url: /
next_url: /docs/roadmap/
permalink: /docs/changelog/
---

Expand Down
4 changes: 2 additions & 2 deletions docs/_pages/0001-roadmap.md → docs/_pages/0004-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
# >/' SPDX-License-Identifier: BSD-2-Clause
# */

title: VSecM Roadmap
title: Roadmap
layout: post
next_url: /docs/about
next_url: /docs/navigation/
prev_url: /
permalink: /docs/roadmap/
---
Expand Down
2 changes: 1 addition & 1 deletion docs/_pages/0020-preface.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
title: Preface
layout: post
next_url: /docs/about/
prev_url: /
prev_url: /docs/community/
permalink: /docs/navigation/
---

Expand Down
2 changes: 1 addition & 1 deletion docs/_pages/0021-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
title: What is VSecM?
layout: post
next_url: /docs/endorsements/
prev_url: /
prev_url: /docs/navigation/
permalink: /docs/about/
---

Expand Down
2 changes: 1 addition & 1 deletion docs/_pages/0030-endorsements.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
title: What People are Saying
layout: post
prev_url: /docs/about/
next_url: /docs/community/
next_url: /docs/quickstart/
permalink: /docs/endorsements/
---

Expand Down
2 changes: 1 addition & 1 deletion docs/_pages/0050-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
title: Quickstart
layout: post
permalink: /docs/quickstart/
prev_url: /docs/community/
prev_url: /docs/endorsements/
next_url: /docs/philosophy/
---

Expand Down
6 changes: 6 additions & 0 deletions docs/assets/gitbook/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -4247,6 +4247,12 @@ h2 {
border-left: 0.81em #BA1C3B solid;
}

h4 {
border-left: 0 !important;
margin-left: 0 !important;
padding-left: 0 !important;
}


body {
text-rendering: optimizeLegibility;
Expand Down

0 comments on commit ae308b4

Please sign in to comment.