Update blog navigation (#235)

* small changes small changes Signed-off-by: Volkan Özçelik <[email protected]> * modifications in blog navigation Signed-off-by: Volkan Özçelik <[email protected]> * whitespace Signed-off-by: Volkan Özçelik <[email protected]> * whitespace Signed-off-by: Volkan Özçelik <[email protected]> * whitespace Signed-off-by: Volkan Özçelik <[email protected]> * whitespace Signed-off-by: Volkan Özçelik <[email protected]> * whitespace Signed-off-by: Volkan Özçelik <[email protected]> * extra instruction for release management. * added videos * doc change * OpenSSF * typo --------- Signed-off-by: Volkan Özçelik <[email protected]>
vmware-tanzu · Sep 1, 2023 · b35cb5b · b35cb5b
1 parent 3d3f934
commit b35cb5b
Show file tree

Hide file tree

Showing 15 changed files with 345 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # VMware Secrets Manager for Cloud-Native Apps
 
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7793/badge)](https://www.bestpractices.dev/projects/7793)
 [![Version](https://img.shields.io/github/v/release/vmware-tanzu/secrets-manager?color=blueviolet)](https://github.com/vmware-tanzu/secrets-manager/releases)
 [![Contributors](https://img.shields.io/github/contributors/vmware-tanzu/secrets-manager.svg?color=orange)](https://github.com/vmware-tanzu/secrets-manager/graphs/contributors)
 [![Slack](https://img.shields.io/badge/slack-vsecm-brightgreen.svg?logo=slack)](https://join.slack.com/t/a-101-103-105-s/shared_invite/zt-1zrr2yepf-2P3EJhfoGNn05l5_4jvYSA)

diff --git a/docs/README.md b/docs/README.md
@@ -20,7 +20,8 @@ next_url: /docs/community/
 ><a href="https://github.com/vmware-tanzu/secrets-manager/blob/main/docs/README.md"
 >edit this page on <strong>GitHub</strong> ✏️</a></p>
 
-<p class="badges"><a href="https://goreportcard.com/report/github.com/vmware-tanzu/secrets-manager"><img src="https://goreportcard.com/badge/github.com/vmware-tanzu/secrets-manager" alt="Go Report Card"></a>
+<p class="badges"><a href="https://www.bestpractices.dev/projects/7793"><img src="https://www.bestpractices.dev/projects/7793/badge" alt="OpenSSF Best Practices"></a>
+<a href="https://goreportcard.com/report/github.com/vmware-tanzu/secrets-manager"><img src="https://goreportcard.com/badge/github.com/vmware-tanzu/secrets-manager" alt="Go Report Card"></a>
 <a href="https://artifacthub.io/packages/helm/vsecm/vsecm"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/vsecm" alt="Artifact Hub"></a>
 <a href="https://twitch.tv/ZeroToHeroDev"><img src="https://img.shields.io/twitch/status/zerotoherodev" alt="Twitch"></a>
 <a href="https://join.slack.com/t/a-101-103-105-s/shared_invite/zt-1zrr2yepf-2P3EJhfoGNn05l5_4jvYSA"><img src="https://img.shields.io/badge/slack-vsecm-brightgreen.svg?logo=slack" alt="Slack"></a>

diff --git a/docs/_includes/body-blog.html b/docs/_includes/body-blog.html
@@ -0,0 +1,60 @@
+<div class="page-wrapper" tabindex="-1" role="main">
+    {% if page.cover %}
+    <img src="{{ page.cover }}"
+         width="100%"
+         height="{{ page.cover_height | default: '100%' }}"
+         alt="{{ page.title | escape }}"
+         style="object-fit: cover;"
+    />
+    {% endif %}
+
+    <div class="page-inner">
+        <div id="book-search-results">
+            <div class="search-noresults">
+                <section class="normal markdown-section">
+                    <p><a href="/">VSecM Home</a>
+                        <svg style="vertical-align: middle" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" height="16" width="16"><defs></defs><path d="M4 13.609333333333334 3.0573333333333332 12.666666666666666l4.666666666666666 -4.666666666666666 -4.666666666666666 -4.666666666666666L4 2.3906666666666663 9.609333333333332 8 4 13.609333333333334z" fill="#000000" stroke-width="0.6666666666666666"></path><path d="M7.333333333333333 13.609333333333334 6.390666666666666 12.666666666666666l4.666666666666666 -4.666666666666666 -4.666666666666666 -4.666666666666666L7.333333333333333 2.3906666666666663 12.942666666666668 8 7.333333333333333 13.609333333333334z" fill="#000000" stroke-width="0.6666666666666666"></path></svg>
+                        <a href="/docs/blog/">VSecM Blog</a>
+
+                        <svg style="vertical-align: middle" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" height="16" width="16"><defs></defs><path d="M8 9.609333333333332 2.3906666666666663 4 3.333333333333333 3.0573333333333332l4.666666666666666 4.666666666666666 4.666666666666666 -4.666666666666666L13.609333333333334 4 8 9.609333333333332z" fill="#000000" stroke-width="0.6666666666666666"></path><path d="M8 12.942666666666668 2.3906666666666663 7.333333333333333 3.333333333333333 6.390666666666666l4.666666666666666 4.666666666666666 4.666666666666666 -4.666666666666666L13.609333333333334 7.333333333333333 8 12.942666666666668z" fill="#000000" stroke-width="0.6666666666666666"></path></svg>
+
+                    </p>
+
+                    {% if page.title %}
+                    <h1 id="{{ page.id }}">{{ page.title | escape }}</h1>
+                    {% else %}
+                    <h1 id="{{ page.id }}">{{ site.title | escape }}</h1>
+                    {% endif %}
+
+                    <p class="blog-author-info">by <a href="{{ page.author_link }}"
+                    ><strong>{{ page.author }}</strong></a><span style="display:inline-block;padding:0 4px">·</span><span
+                    >{{ page.published_at }}</span></p>
+
+                    {{ content }}
+
+                    {%- if jekyll.environment != 'dev' and site.disqushandler -%}
+                    {%- include disqus.html -%}
+                    {%- endif -%}
+                </section>
+            </div>
+
+            {%- include search.html -%}
+        </div>
+    </div>
+</div>
+
+{% include mathjax.html %}
+
+
+<p class="copyright">
+    Copyright © 2023-present VMware, Inc.<br><br>
+    <strong>VMware Secrets Manager</strong> for Cloud-Native Apps<br>
+    code is distributed under <a href="https://github.com/vmware-tanzu/secrets-manager/blob/main/LICENSE">BSD 2-Clause License</a>.<br>
+    <br>
+    The documentation on this website<br>
+    is distributed under <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a>.
+    <br><br>
+    <a href="https://vsecm.com/docs/community/">contact</a> |
+    <a href="https://vsecm.com/docs/privacy/">privacy policy</a>
+    <br><br>
+</p>
diff --git a/docs/_includes/toc-date.html b/docs/_includes/toc-date.html
@@ -41,22 +41,23 @@
                             <li class="divider"></li>
                         {% endif %}
 
-
-
-            {% 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}}">
-                        {% endif %}
-                            <a href="{{site.baseurl}}{{post.url}}">
-                                {{ post.title | escape }}
-                            </a>
-                            {% if site.toc.enabled %}
+                        {% if post.kind != "VSecMBlog" %}
+                            {% 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}}">
+                            {% endif %}
+                                <a href="{{site.baseurl}}{{post.url}}">
+                                    {{ post.title | escape }}
+                                </a>
+                                {% if site.toc.enabled %}
                                 {% if page.url == post.url %}
-                                    {% include toc.html html=content h_min=site.toc.h_min h_max=site.toc.h_max %}
+                                {% include toc.html html=content h_min=site.toc.h_min h_max=site.toc.h_max %}
                                 {% endif %}
-                            {% endif %}
-                        </li>
+                                {% endif %}
+                            </li>
+                        {% endif %}
+
                     {% endfor %}
 
                     {% if reversed_posts.size > 0 %}

diff --git a/docs/_includes/toc-page.html b/docs/_includes/toc-page.html
@@ -0,0 +1,73 @@
+<div class="page-wrapper" tabindex="-1" role="main">
+    {% if page.cover %}
+    <img src="{{ page.cover }}"
+         width="100%"
+         height="{{ page.cover_height | default: '100%' }}"
+         alt="{{ page.title | escape }}"
+         style="object-fit: cover;"
+    />
+    {% endif %}
+
+    <div class="page-inner">
+        <div id="book-search-results">
+            <div class="search-noresults">
+                <section class="normal markdown-section">
+                    <h1>VMware Secrets Manager Blog</h1>
+
+                    {% for collection in site.collections %}
+                        {% if collection.output %}
+                            {% if collection.label == "posts" %}
+                                {% assign reversed_posts = site[collection.label] | reverse %}
+                            {% else %}
+                                {% assign reversed_posts = site[collection.label] %}
+                            {% endif %}
+
+                        {% for post in reversed_posts %}
+
+
+                        {% if post.kind == "VSecMBlog" %}
+                        <a href="{{site.baseurl}}{{post.url}}" class="blog-listing-link">
+                            <h2>{{ post.title | escape }}</h2>
+                            <p>{{ post.excerpt | truncate: 250, "…" }}</p>
+                            <p class="blog-author-info">by <span
+                            ><strong>{{ post.author }}</strong></span><span
+                            style="display:inline-block;padding:0 4px">·</span><span
+                            >{{ post.published_at }}</span></p>
+                        </a>
+                        {% endif %}
+                    {% endfor %}
+
+                    {% if reversed_posts.size > 0 %}
+                    {% endif %}
+                    {% endif %}
+                    {% endfor %}
+
+
+
+
+                    {%- if jekyll.environment != 'dev' and site.disqushandler -%}
+                    {%- include disqus.html -%}
+                    {%- endif -%}
+                </section>
+            </div>
+
+            {%- include search.html -%}
+        </div>
+    </div>
+</div>
+
+{% include mathjax.html %}
+
+
+<p class="copyright">
+    Copyright © 2023-present VMware, Inc.<br><br>
+    <strong>VMware Secrets Manager</strong> for Cloud-Native Apps<br>
+    code is distributed under <a href="https://github.com/vmware-tanzu/secrets-manager/blob/main/LICENSE">BSD 2-Clause License</a>.<br>
+    <br>
+    The documentation on this website<br>
+    is distributed under <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a>.
+    <br><br>
+    <a href="https://vsecm.com/docs/community/">contact</a> |
+    <a href="https://vsecm.com/docs/privacy/">privacy policy</a>
+    <br><br>
+</p>
diff --git a/docs/_layouts/blog-home.html b/docs/_layouts/blog-home.html
@@ -0,0 +1,54 @@
+<!DOCTYPE HTML>
+<html lang="en" >
+<head>
+
+    {%- include head.html -%}
+
+    {% if page.previous %}
+    <link rel="prev" href="{{site.baseurl}}{{page.previous.url}}" />
+    {% else %}
+    <link rel="prev" href="{{site.baseurl}}/" />
+    {% endif %}
+
+    {% if page.next %}
+    <link rel="next" href="{{site.baseurl}}{{page.next.url}}" />
+    {% endif %}
+</head>
+<body>
+<div class="book">
+    <h1>home sweet home</h1>
+
+
+    {%- include toc-date.html -%}
+
+    <div class="book-body">
+        <div class="book-header" role="navigation">
+            <!-- Title -->
+            <h1>
+                <i class="fa fa-circle-o-notch fa-spin"></i>
+                {% if page.title %}
+                <a href="." >{{ page.title | escape }}</a>
+                {% else %}
+                <a href="." >{{ site.title | escape }}</a>
+                {% endif %}
+            </h1>
+        </div>
+
+        <div class="body-inner">
+
+            {%- include toc-page.html -%}
+        </div>
+    </div>
+
+    <script>
+        var gitbook = gitbook || [];
+        gitbook.push(function() {
+            gitbook.page.hasChanged({%- include metadata-post.json.tpl -%});
+        });
+    </script>
+</div>
+
+{%- include footer.html -%}
+
+</body>
+</html>
diff --git a/docs/_layouts/blog.html b/docs/_layouts/blog.html
@@ -0,0 +1,51 @@
+<!DOCTYPE HTML>
+<html lang="en" >
+<head>
+
+    {%- include head.html -%}
+
+    {% if page.previous %}
+    <link rel="prev" href="{{site.baseurl}}{{page.previous.url}}" />
+    {% else %}
+    <link rel="prev" href="{{site.baseurl}}/" />
+    {% endif %}
+
+    {% if page.next %}
+    <link rel="next" href="{{site.baseurl}}{{page.next.url}}" />
+    {% endif %}
+</head>
+<body>
+<div class="book">
+
+    {%- include toc-date.html -%}
+
+    <div class="book-body">
+        <div class="book-header" role="navigation">
+            <!-- Title -->
+            <h1>
+                <i class="fa fa-circle-o-notch fa-spin"></i>
+                {% if page.title %}
+                <a href="." >{{ page.title | escape }}</a>
+                {% else %}
+                <a href="." >{{ site.title | escape }}</a>
+                {% endif %}
+            </h1>
+        </div>
+
+        <div class="body-inner">
+            {%- include body-blog.html -%}
+        </div>
+    </div>
+
+    <script>
+        var gitbook = gitbook || [];
+        gitbook.push(function() {
+            gitbook.page.hasChanged({%- include metadata-post.json.tpl -%});
+        });
+    </script>
+</div>
+
+{%- include footer.html -%}
+
+</body>
+</html>
diff --git a/docs/_layouts/post.html b/docs/_layouts/post.html
@@ -50,8 +50,8 @@ <h1>
                         <i class="fa fa-angle-right"></i>
                     </a>
                     {% else %}
-                    <a href="{{site.baseurl}}/" class="navigation navigation-prev navigation-unique">
-                        <i class="fa fa-angle-left"></i>
+                    <a href="{{site.baseurl}}/" class="navigation navigation-next navigation-unique">
+                        <i class="fa fa-angle-right"></i>
                     </a>
                     {% endif %}
                 </div>

diff --git a/docs/_pages/0000-community.md b/docs/_pages/0000-community.md
@@ -27,6 +27,11 @@ next_url: /docs/contributor-sync/
 > This page outlines various community events and communication channels.
 {: .block-tip}
 
+## Empower Our Journey ✊
+
+[⭐️ Star **VMware Secrets Manager** to show your support](https://github.com/vmware-tanzu/secrets-manager).
+Your support helps us to reach out to even more people with this amazing tech.
+
 ## Join Our Community on Slack 
 
 Open Source is better together. 

diff --git a/docs/_pages/0005-blog.md b/docs/_pages/0005-blog.md
@@ -10,7 +10,7 @@
 # */
 
 title: VSecM Blog
-layout: post
+layout: blog-home
 prev_url: /docs/security/
 permalink: /docs/blog/
 next_url: /docs/navigation/
@@ -24,4 +24,4 @@ next_url: /docs/navigation/
 
 In the ever-evolving landscape of cloud-native applications, secrets management
 is critical to ensuring sensitive information’s security and integrity. While
-several solutions are... [Read More](/blog/keep-your-secrets/)
+several solutions are… [Read More](/blog/keep-your-secrets/)
diff --git a/docs/_pages/0130-contributing.md b/docs/_pages/0130-contributing.md
@@ -268,7 +268,7 @@ you have successfully set up your local docker registry for your
 > **Make a Big McTunnel**
 >
 > If you have `localhost:5000` unallocated, there is a `make mac-tunnel`
-> target in the **VMware Secrets Manager**’ project **Makefile** that will 
+> target in the **VMware Secrets Manager**’s project **Makefile** that will 
 > automatically find the exposed docker registry port, and establish a 
 > tunnel for you.
 >

diff --git a/docs/_pages/0250-showcase.md b/docs/_pages/0250-showcase.md
@@ -31,6 +31,26 @@ next_url: /
 > Thank you for your patience and understanding 🙏.
 {: .block-warning}
 
+## VSecM QuickStart
+
+<div style="padding:56.25% 0 0 0;position:relative;"
+><iframe src="https://player.vimeo.com/video/849328819?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" 
+frameborder="0" allow="autoplay; fullscreen; picture-in-picture" 
+style="position:absolute;top:0;left:0;width:100%;height:100%;" 
+title="VMware Secrets Manager (for Cloud-Native Apps) Quickstart"
+></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
+
+## VSecM Installation
+
+<div style="padding:56.25% 0 0 0;position:relative;"
+><iframe src="https://player.vimeo.com/video/858886142?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" 
+frameborder="0" allow="autoplay; fullscreen; picture-in-picture" 
+style="position:absolute;top:0;left:0;width:100%;height:100%;" 
+title="VMware Secrets Manager: Installation"
+></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>
+
+## Aegis
+
 **VMware Secrets Manager** *for Cloud-Native Apps* is a successor of 
 a project called [**Aegis**][aegis]. The project was [renamed to 
 **VMware Secrets Manager** and moved under the **VMware Tanzu** GitHub 

diff --git a/docs/_pages/0980-release-management.md b/docs/_pages/0980-release-management.md
@@ -42,6 +42,19 @@ We (*still*) have a manual build process, so you will need access to the
 You can of course build **VSecM** locally, but without the build server, you
 won’t be able to push the images to the registry and tag the release.
 
+## Make Sure We Are Ready for a Release Cut
+
+Check out [this internal link][release] to see if there is any outstanding 
+issues for the release. If they can be closed, close them. If they cannot
+be closed, move them to the next version.
+
+## Make Sure You Update the Release Notes
+
+* Add any publicly-known vulnerabilities that are fixed in this release.
+* Add any significant changes completed to the release notes.t 
+
+[release]: https://github.com/orgs/vmware-tanzu/projects/70/views/1 
+
 ## Configuring Minikube Local Registry
 
 Switch to the `$WORKSPACE/secrets-manager` project folder