Skip to content

Commit

Permalink
add miniasync sub-page with initial content
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszstolarczuk committed Jul 6, 2022
1 parent bdd287a commit a9c1e21
Show file tree
Hide file tree
Showing 6 changed files with 249 additions and 1 deletion.
5 changes: 5 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -143,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"
Expand Down
2 changes: 1 addition & 1 deletion content/announcements/2022/MiniAsync-v0-1-0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: ""
image: "https://opengraph.githubassets.com/706d2635f355e31fa44b50d0e337af4ce73086e7/pmem/miniasync"

# Announcement category
announcements: ['pmem']
announcements: ['miniasync']

# Post type
type: "announcement"
Expand Down
17 changes: 17 additions & 0 deletions content/miniasync/_index.md
Original file line number Diff line number Diff line change
@@ -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)
-->
98 changes: 98 additions & 0 deletions data/en/miniasync.yml
Original file line number Diff line number Diff line change
@@ -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."
104 changes: 104 additions & 0 deletions themes/pmem-hugo/layouts/miniasync/list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{{ define "main" }}

<!-- slider -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.miniasync.slider.enable }} {{ with $data.miniasync.slider }}
<section id="page-title" class="page-title-parallax page-title-center page-title-dark include-header skrollable skrollable-between" style="background-image: url('{{.bg_image}}'); background-size: cover; padding: 120px 0px; margin-top: -157.05px">
<div class="container clearfix mt-4">
<div class="slider-title">
<h2 style="color: white">{{ .title | markdownify }}</h2>
<p style="color: white">{{ .content | safeHTML }}</p>
</div>
</div>
</section>
{{ end }} {{ end }}

<div class="section m-0 bg-transparent library-section border-top dark-mode">
<div class="container">
<div class="row justify-content-between">

<div class="col mt-0 lib-content">
<!-- c api -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.miniasync.c_api.enable }} {{ with $data.miniasync.c_api }}

<!-- ## branch lists -->
{{ range .lists }}
<p>{{ .content | safeHTML }}</p>
<ul class="pmem-list">
{{ range .list_items }}
<li>
{{ .content | safeHTML }}
</li>
{{ end }}
</ul>
{{ end }}
{{ end }} {{ end }}
<!-- end c api -->

<!-- blog entries -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.miniasync.blog_entries.enable }} {{ with $data.miniasync.blog_entries }}
<h3 class>{{ .title | markdownify }}</h3>
<p>{{ .content | safeHTML }}</p>
{{ end }} {{ end}}
<!-- end blog entries -->

<!-- announcements -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.miniasync.announcements.enable }} {{ with $data.miniasync.announcements }}
<h3 class>{{ .title | markdownify }}</h3>
<p>{{ .content | safeHTML }}</p>
{{ end }} {{ end}}
<!-- end announcements -->

<!-- releases support -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.miniasync.releases_support_status.enable }} {{ with $data.miniasync.releases_support_status }}
<h3 class>{{ .title | markdownify }}</h3>
<p>{{ .content.recent_release_content | safeHTML }}</p>

<!-- ## release branches table -->
<table class="table table-bordered pmem-table dark-mode">
<thead>
<tr>
{{ range .table.headers}}
<th>{{ .content | markdownify }}</th>
{{ end }}
</tr>
</thead>
<tbody>
{{ range .table.rows }}
<tr>
{{ range .cols }}
<td>{{ .content | markdownify }}</td>
{{ end }}
</tr>
{{ end }}
</tbody>
</table>

<!-- ## possible statuses list -->
<p>{{ .content.possible_statuses_content | safeHTML }}</p>
<ol class="pmem-list">
{{ range .possible_statuses_list.list_items }}
<li>
{{ .content | safeHTML }}
<ul class="pmem-list">
{{ range .children }}
<li>{{ .content | safeHTML }}</li>
{{ end }}
</ul>
</li>
{{ end }}
</ol>
{{ end }} {{ end }}
<!-- end releases support -->

<!-- disclaimer -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.miniasync.disclaimer.enable }} {{ with $data.miniasync.disclaimer }}
<div class="divider"></div>
<p class="text-center"><small>{{ .content | safeHTML }}</small></p>
{{ end }} {{ end }}
<!-- end disclaimer -->
</div>
</div>
</div>
</div>

{{ end }}
24 changes: 24 additions & 0 deletions themes/pmem-hugo/layouts/miniasync/single.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{{ define "main" }}
<!-- silder -->
<section id="page-title" class="page-title-parallax page-title-center page-title-dark include-header skrollable skrollable-between" style="background-image: url('{{.Params.bg_image}}'); background-size: cover; padding: 120px 0px; margin-top: -157.05px">
<div class="container clearfix mt-4">
<div class="slider-title text-light">
<h2 style="color: white">{{ .Params.header | markdownify }}</h2>
</div>
</div>
</section>

<div class="section m-0 bg-transparent library-section dark-mode">
<div class="container">
<div class="row justify-content-between">
<div class="col mt-0 lib-content">
{{ .Content | replaceRE "<table>" "<table class=\"table table-bordered pmem-table dark-mode\">" | markdownify }}
</div>
</div>
<!-- disclaimer -->
<div class="divider"></div>
<p class="text-center"><small>{{ .Params.disclaimer | safeHTML }}</small></p>
<!-- end disclaimer -->
</div>
</div>
{{ end }}

0 comments on commit a9c1e21

Please sign in to comment.