Added _releases folder and notes file for 1.0.0 (#174)

Added _releases folder and release_notes_1.0.0.md (unpopulated), updated _config.yml to reference _releases, and removed extra 'Microsoft' from index.markdown. This PR adds a folder in which we can store the .md files for the release notes; adds the file to the doc tree at the website. Also removes extra 'Microsoft' from index.markdown, and updates _config.yml. Signed-off-by: susanmdouglas [email protected]
babelfish-for-postgresql · Mar 10, 2022 · 7139cbc · 7139cbc
1 parent 95089a9
commit 7139cbc
Show file tree

Hide file tree

Showing 10 changed files with 86 additions and 15 deletions.
diff --git a/RELEASE_STEPS.md b/RELEASE_STEPS.md
@@ -0,0 +1,54 @@
+# Release Notes publishing checklist
+
+- Add the release note text inside `_includes/releases` folder as a markdown file, without headers.
+  As the contents of these files are raw, they can be checked out from external sources (once the docs have 
+  been moved to the extensions repository).
+
+- Add the version details in `_versions`, with the following content and updating the corresponding
+  version number and the correct filename in the `explanation` attribute (without the `_includes` parent
+  directory):
+
+```markdown
+---
+date: 2022-01-01
+
+title: Babelfish 1.0.0
+product: Babelfish for PostgreSQL
+version: '1.0.0'
+
+components:
+  -
+    role: engine
+    artifact: babelfish
+    version: 1.0.0
+sections:
+  source:
+    explanation: "/releases/babelfish-1.0.0.md"
+pretty:
+  artifacts:
+    babelfish: ''
+  sections:
+    source: 'Babelfish 1.0.0'
+---
+Babelfish for PostgreSQL is open source software that uses the Apache License version 2 (ALv2) and PostgreSQL License. Project source is freely available on [GitHub](https://github.com/babelfish-for-postgresql). 
+```
+
+The text below the header of this content will be rendered in the right sidebar of the release note page.
+
+
+> The above bullets will make the releases available in `<url>/versions` permalink and in the documentation
+sidebar. The versions route is not accessible from the UI, only by linking. eg: babelfish.org/versions
+
+- Add the release link in the `index.markdown`, to appear in the front page. Be aware of the page name, it will
+have the `<artifact>-<version with dots replaced by hyphen>.html` convention:
+
+```markdown
+sidebar:
+  - title: Releases
+    description: List of Babelfish releases.
+    links:
+      - title: Release 1.0.0
+        url: "/versions/babelfish-1-0-0.html"
+  ...
+  - title: Have a question?
+```
diff --git a/_config.yml b/_config.yml
@@ -84,15 +84,18 @@ collections:
   faq:
     permalink: /docs/:collection/:path/
     output: true
+  versions:
+    permalink: /versions/:path/
+    output: true
   docs:
     permalink: /:collection/:path/
     output: true
   events:
     output: true
   artifacts:
     output: true
-  versions:
-    output: true
+
+
 
 paginate: 5
 paginate_path: "/blog/page:num/"
@@ -116,6 +119,10 @@ just_the_docs:
     faq:
       name: FAQ and getting help
       nav_fold: true
+    versions:
+      name: Releases
+      nav_fold: true
+
 
 # Enable or disable the site search
 # Supports true (default) or false

diff --git a/_includes/nav.html b/_includes/nav.html
@@ -58,7 +58,7 @@
   {%- assign pages_list = sorted_number_ordered_pages | concat: sorted_string_ordered_pages -%}
 
   {%- for node in pages_list -%}
-    {%- if node.parent == nil and node.url contains '/docs' -%}
+    {%- if node.parent == nil -%}
 
       {%- unless node.nav_exclude -%}
       <li class="nav-list-item{% if page.collection == include.key and page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">

diff --git a/_includes/post_import.html b/_includes/post_import.html
@@ -1,7 +1,7 @@
 {% if page.odfeimport %}
 <div class="imported-post">
-    This post was imported from the <i>Open Distro For Elasticsearch</i> blog, 
-    a predecessor project of OpenSearch. Information reflected in this post
-     may not be current or accurate.
+    This post was imported from the <i>Babelfish for PostgreSQL</i> blog. 
+    Babelfish is a PostgreSQL extension that supports SQL Server SQL syntax on a PostgreSQL server.. 
+    Information in this post may not be current or accurate.
 </div>
 {% endif %}
diff --git a/_includes/releases/babelfish-1.0.0.md b/_includes/releases/babelfish-1.0.0.md
@@ -0,0 +1,2 @@
+
+_1.0.0 Release description_
diff --git a/_layouts/versions.html b/_layouts/versions.html
@@ -11,7 +11,7 @@
   platforms:
     linux: "Linux"
   sections:
-    source: 'Build babelfish from source code'
+    source: 'Babelfish Release'
 
 architecture_order: 
   - x64

diff --git a/_versions/2021-10-28-babelfish-1.0.markdown → _versions/babelfish-1.0.0.md b/_versions/2021-10-28-babelfish-1.0.markdown → _versions/babelfish-1.0.0.md
@@ -1,5 +1,8 @@
 ---
-date: 2021-10-28
+date: 2022-01-04
+
+title: Babelfish 1.0.0
+nav_order: 1
 
 product: Babelfish for PostgreSQL
 version: '1.0.0'
@@ -11,9 +14,11 @@ components:
     version: 1.0.0
 sections:
   source:
-    explanation: "downloads/babelfish-source.markdown"
+    explanation: "/releases/babelfish-1.0.0.md"
 pretty:
   artifacts:
     babelfish: ''
+  sections:
+    source: 'Babelfish 1.0.0'
 ---
 Babelfish for PostgreSQL is open source software that uses the Apache License version 2 (ALv2) and PostgreSQL Licence. ALv2 grants you well-understood usage rights; you can use, modify, extend, embed, monetize, resell, and offer Babelfish for PostgreSQL as part of your products and services. The source for the entire project is available on [GitHub](https://github.com/babelfish-for-postgresql) and you're welcome to build from source for customized deployments. 
diff --git a/index.markdown b/index.markdown
@@ -7,7 +7,7 @@ layout_class: sidebar-right
 body_class: homepage
 sectionid: homepage
 
-meta_description: Babelfish for PostgreSQL is an Apache-2.0 open source project that adds a Microsoft SQL Server-compatible end-point to PostgreSQL to enable your PostgreSQL database to understand the SQL Server wire protocol and commonly used SQL Server commands. With Babelfish, PostgreSQL now understands T-SQL, Microsoft SQL Server's proprietary SQL dialect, and supports the same communications protocol, so your apps that were originally written for SQL Server can now work with PostgreSQL with fewer code changes and without changing database drivers.
+meta_description: Babelfish for PostgreSQL is an Apache-2.0 open source project that adds a Microsoft SQL Server-compatible end-point to PostgreSQL to enable your PostgreSQL database to understand the SQL Server wire protocol and commonly used SQL Server commands. With Babelfish, PostgreSQL now understands T-SQL, SQL Server's proprietary SQL dialect, and supports the same communications protocol, so your apps that were originally written for SQL Server can now work with PostgreSQL with fewer code changes and without changing database drivers.
 
 download_ctas:
   - os
@@ -46,8 +46,13 @@ secondary:
   content: "Check out the [forums](https://discuss.babelfishpgcommunity.dev) to stay informed."
 
 sidebar:
+  - title: Releases
+    description: List of Babelfish releases.
+    links:
+      - title: Release 1.0.0
+        url: "/versions/babelfish-1-0-0.html"
   - title: Have a question?
-    description: Do you have a question regarding Babelfish? Maybe you aren’t the first to ask it. Checkout our frequently asked questions (FAQ) to see if your question is already answered. If not, don’t hesitate to ask in the community forums.
+    description: Do you have a question about Babelfish? You may not be the first person to ask it. Visit our Frequently Asked Questions (FAQ) to see if your question has been answered. If not, don’t hesitate to ask and we'll be glad to answer.
     links:
       - title: Check out the FAQ
         url:  /docs/faq/

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "opensearchwebsite",
+  "name": "babelfishwebsite",
   "private": true,
   "dependencies": {
     "bower": "^1.4.1"

diff --git a/versions/index.html b/versions/index.html
@@ -4,8 +4,6 @@
 <ul>
   {% assign versions = site.versions | sort: 'date' | reverse %}
   {% for version in versions %}
-    <li><a href="{{ version.url }}">
-      {% if version.product == 'odfe' %} Open Distro for Elasticsearch {% else %} OpenSearch {%endif%} {{ version.version }}</a>
-    </li>
+    <li><a href="{{ version.url }}"> Babelfish {{ version.version }}</a> </li>
   {% endfor %}
 </ul>