Merge pull request #260 from lukaszstolarczuk/add-new-sub-pages

Add new sub pages (for stream and miniasync)

config.toml

@@ -114,6 +114,11 @@ weight = 1
     name = "PMemKV"
     url = "/pmemkv"
 
+    [[Languages.en.menu.main]]
+    parent = "dev-hub-column1"
+    name = "PMemStream"
+    url = "/pmemstream"
+
     [[Languages.en.menu.main]]
     parent = "dev-hub-column1"
     name = "PMem Repositories"
@@ -138,6 +143,11 @@ weight = 1
     name = "Newsletter "
     url = "/community/#newsletter"
 
+    [[Languages.en.menu.main]]
+    parent = "dev-hub-column2"
+    name = "MiniAsync "
+    url = "/miniasync"
+
 [[Languages.en.menu.main]]
 name = "Learn"
 url = "/learn"

content/announcements/2022/MiniAsync-v0-1-0-release.md

@@ -18,7 +18,7 @@ description: ""
 image: "https://opengraph.githubassets.com/706d2635f355e31fa44b50d0e337af4ce73086e7/pmem/miniasync"
 
 # Announcement category
-announcements: ['pmem']
+announcements: ['miniasync']
 
 # Post type
 type: "announcement"

content/announcements/2022/pmemstream-v0-2-0-release.md

@@ -18,7 +18,7 @@ description: ""
 image: "/images/posts/pmemstream_intro.png"
 
 # Announcement category
-announcements: ['pmem']
+announcements: ['pmemstream']
 
 # Post type
 type: "announcement"

content/blog/2022/pmemstream-intro.md

@@ -23,9 +23,10 @@ image: "/images/posts/pmemstream_intro.png"
 author: "lukaszstolarczuk"
 
 # Categories to which this blog post belongs
-blogs: ['Pmemstream']
+blogs: ['pmemstream']
+
 # Blog tags
-tags: ["Intro"]
+tags: ["Intro", "pmemstream", "pmdk", "pmem use case"]
 
 # Blog post type
 type: "post"
@@ -43,6 +44,9 @@ Current implementation, examples, and known caveats are accessible at the [pmems
 Please bear in mind this library is still in an early stage of development. As this is a work in progress,
 its behavior or APIs may change without prior notice.
 
+For more information about pmemstream you can also see
+[its sub-page on this website][pmem_io_subpage].
+
 # Why we implement it?
 
 As keen PMDK users should know by now, we already have [libpmemlog][pmemlog_pmem_io] in our portfolio.
@@ -108,6 +112,7 @@ feedback with us (perhaps, an improvement idea, or just to show your interest),
 
 [pmdk_feat_issue]: https://github.com/pmem/pmdk/issues/4930
 [pmemstream_gh]: https://github.com/pmem/pmemstream
+[pmem_io_subpage]: /pmemstream
 [pmemstream_gh_issue]: https://github.com/pmem/pmemstream/issues
 [pmemstream_gh_async]: https://github.com/pmem/pmemstream/issues/76
 [pmemstream_gh_multi]: https://github.com/pmem/pmemstream/issues/75

content/miniasync/_index.md

@@ -0,0 +1,17 @@
+---
+title: "MiniAsync"
+draft: false
+# page title background image
+bg_image: ""
+# meta description
+description: ""
+type: "/miniasync"
+---
+
+<!--
+    This page is generated based on:
+    - script page 'themes/pmem-hugo/layouts/miniasync/list.html', and
+    - content in 'data/<lang>/miniasync'
+
+    + manpages located here (/content/miniasync)
+-->

content/pmemkv/_index.md

@@ -12,4 +12,6 @@ type: "/pmemkv"
     This page is generated based on:
     - script page 'themes/pmem-hugo/layouts/pmemkv/list.html', and
     - content in 'data/<lang>/pmemkv'
+
+    + manpages located here (/content/pmemkv)
 -->

content/pmemstream/_index.md

@@ -0,0 +1,17 @@
+---
+title: "PMemStream"
+draft: false
+# page title background image
+bg_image: ""
+# meta description
+description: ""
+type: "/pmemstream"
+---
+
+<!--
+    This page is generated based on:
+    - script page 'themes/pmem-hugo/layouts/pmemstream/list.html', and
+    - content in 'data/<lang>/pmemstream'
+
+    + manpages located here (/content/pmemstream)
+-->

data/en/miniasync.yml

@@ -0,0 +1,98 @@
+################################# Slider #####################################
+slider:
+  enable: true
+  bg_image: '/images/backgrounds/faq_header.jpg'
+  title: 'miniasync'
+  content: "The <strong>Mini Library for Asynchronous Programming in C</strong> is a C low-level concurrency library for asynchronous functions.<br />
+  This is still an experimental, pre-release software.<br />
+  Up-to-date information and the most recent changes can be found on <a href=\"https://github.com/pmem/miniasync\">our GitHub page</a>."
+
+################################# C API #################################
+c_api:
+  enable: true
+  lists:
+    branch_list1: 
+      content: "<p>C API of miniasync is documented in the form of manpages.</p>
+                <p>For the current <strong>master</strong> branch:</p>"
+      list_items:
+        list_item1:
+          content: "(available soon)"
+
+################################# Blog Entries #################################
+blog_entries:
+  enable: true
+  title: "Blog Entries"
+  content: "Blog posts related to miniasync can be found using <a href=\"/tags/miniasync/\">dedicated blog tag</a>."
+
+################################# Blog Entries #################################
+announcements:
+  enable: true
+  title: "Announcements"
+  content: "All news and announcements (e.g., about recent releases) related to miniasync can be found <a href=\"/announcements/miniasync/\">here</a>."
+
+################################# Releases Support Status #################################
+releases_support_status:
+
+  ### to be enabled when library is more mature (after 1.0 release?)
+  enable: false
+  title: "Releases' Support Status"
+  content:
+    recent_release_content: "This is still an experimental, pre-release software developed on a single branch. It should not be used in production systems. APIs and file formats may change at any time without preserving backwards compatibility. All known issues and limitations are logged as GitHub issues. The most recent releases can be found on the <a href=\"https://github.com/pmem/miniasync/releases\">\"releases\" tab on the Github page</a>."
+    possible_statuses_content: "Possible statuses:"
+  table:
+    headers:
+      header1:
+        content: "Version branch"
+      header2:
+        content: "First release date"
+      header3:
+        content: "Last patch release"
+      header4:
+        content: "Maintenance status"
+    rows:
+      row1:
+        cols:
+          col1:
+            content: "master"
+          col2:
+            content: "0.1.0 (May 20, 2022)"
+          col3:
+            content: "N/A"
+          col4:
+            content: "Full, in development"
+  possible_statuses_list:
+      list_items:
+        list_item1:
+          content: "Full maintenance:"
+          children:
+            child_1:
+              content: "All/most of bugs fixed (if possible),"
+            child_2:
+              content: "Patch releases issued based on a number of fixes and their severity,"
+            child_3:
+              content: "At least one release at the end of the maintenance period,"
+            child_4:
+              content: "Full support for at least a year since the initial release."
+        list_item2:
+          content: "Limited scope:"
+          children:
+            child_1:
+              content: "Only critical bugs (security, data integrity, etc.) will be backported,"
+            child_2:
+              content: "Patch versions will be released when needed (based on severity of found issues),"
+            child_3:
+              content: "Branch will remain in “limited maintenance” status based on original release availability in popular distros."
+        list_item3:
+          content: "EOL:"
+          children:
+            child_1:
+              content: "No support,"
+            child_2:
+              content: "No bug fixes,"
+            child_3:
+              content: "No official releases."
+
+################################# Disclaimer #################################
+disclaimer:
+  enable: true
+  content: "The contents of this web site and the associated <a href=\"https://github.com/pmem\">GitHub repositories</a> are BSD-licensed open source."

data/en/pmemstream.yml

@@ -0,0 +1,108 @@
+################################# Slider #####################################
+slider:
+  enable: true
+  bg_image: '/images/backgrounds/faq_header.jpg'
+  title: 'pmemstream'
+  content: "<strong>pmemstream</strong> is a logging data structure optimized for persistent memory.<br />
+  This is still an experimental, pre-release software.<br />
+  Up-to-date information and the most recent changes can be found on <a href=\"https://github.com/pmem/pmemstream\">our GitHub page</a>."
+
+################################# C API #################################
+c_api:
+  enable: true
+  lists:
+    branch_list1: 
+      content: "<p>C API of pmemstream is documented in the form of manpages.</p>
+                <p>For the current <strong>master</strong> branch:</p>"
+      list_items:
+        list_item1:
+          content: "<a href=\"./master/manpages/libpmemstream.3.html\">libpmemstream.3</a>"
+        list_item2:
+          content: "<a href=\"./master/manpages/libpmemstream.7.html\">libpmemstream.7</a>"
+
+#################################  Performance reports ################################# 
+performance_reports:
+
+  ### to be enabled when available
+  enable: false
+  title: "Performance Reports"
+  content: "Available performance measurements can be found in <a href=\"/pmemstream/reports\">'reports' sub-section</a>."
+
+################################# Blog Entries #################################
+blog_entries:
+  enable: true
+  title: "Blog Entries"
+  content: "Blog posts related to pmemstream can be found using <a href=\"/tags/pmemstream/\">dedicated blog tag</a>."
+
+################################# Blog Entries #################################
+announcements:
+  enable: true
+  title: "Announcements"
+  content: "All news and announcements (e.g., about recent releases) related to pmemstream can be found <a href=\"/announcements/pmemstream/\">here</a>."
+
+################################# Releases Support Status #################################
+releases_support_status:
+
+  ### to be enabled when library is more mature (after 1.0 release?)
+  enable: false
+  title: "Releases' Support Status"
+  content:
+    recent_release_content: "This is still an experimental, pre-release software developed on a single branch. It should not be used in production systems. APIs and file formats may change at any time without preserving backwards compatibility. All known issues and limitations are logged as GitHub issues. The most recent releases can be found on the <a href=\"https://github.com/pmem/pmemstream/releases\">\"releases\" tab on the Github page</a>."
+    possible_statuses_content: "Possible statuses:"
+  table:
+    headers:
+      header1:
+        content: "Version branch"
+      header2:
+        content: "First release date"
+      header3:
+        content: "Last patch release"
+      header4:
+        content: "Maintenance status"
+    rows:
+      row1:
+        cols:
+          col1:
+            content: "master"
+          col2:
+            content: "0.1.0 (Dec 03, 2021)"
+          col3:
+            content: "0.2.0 (Jun 28, 2022)"
+          col4:
+            content: "Full, in development"
+  possible_statuses_list:
+      list_items:
+        list_item1:
+          content: "Full maintenance:"
+          children:
+            child_1:
+              content: "All/most of bugs fixed (if possible),"
+            child_2:
+              content: "Patch releases issued based on a number of fixes and their severity,"
+            child_3:
+              content: "At least one release at the end of the maintenance period,"
+            child_4:
+              content: "Full support for at least a year since the initial release."
+        list_item2:
+          content: "Limited scope:"
+          children:
+            child_1:
+              content: "Only critical bugs (security, data integrity, etc.) will be backported,"
+            child_2:
+              content: "Patch versions will be released when needed (based on severity of found issues),"
+            child_3:
+              content: "Branch will remain in “limited maintenance” status based on original release availability in popular distros."
+        list_item3:
+          content: "EOL:"
+          children:
+            child_1:
+              content: "No support,"
+            child_2:
+              content: "No bug fixes,"
+            child_3:
+              content: "No official releases."
+
+################################# Disclaimer #################################
+disclaimer:
+  enable: true
+  content: "The contents of this web site and the associated <a href=\"https://github.com/pmem\">GitHub repositories</a> are BSD-licensed open source."

static/css/custom.css

@@ -365,7 +365,8 @@ div.grid-filter-wrap li {
   color: #fff;
 }
 
-.pmemkv-list {
+.pmemkv-list,
+.pmem-list {
   padding-left: 2rem !important;
 }