Skip to content

Commit

Permalink
common: end up the winding down period
Browse files Browse the repository at this point in the history
- remove banner from the main page
- add banner to the template for all PMDK libraries
- point the place where users can submit issues and ask questions

Signed-off-by: Jan Michalski <[email protected]>
  • Loading branch information
janekmi committed Aug 29, 2023
1 parent 0e658d1 commit 0fc0c09
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 36 deletions.
12 changes: 0 additions & 12 deletions data/en/homepage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,6 @@ slider:
label: 'Join the community'
link: '/community/'

################################# Banner #####################################
banner:
enable: true
bg_image: ''
title: ''
content_banner:
bold_text: 'Winding down of PMDK development!'
text: 'Libraries and all related resources will continue to be available, but development and maintenance will be limited.'
download_link:
label: 'Read our blog post for more details and Q&A!'
link: 'https://pmem.io/blog/2022/11/update-on-pmdk-and-our-long-term-support-strategy/'

################################# Feature #####################################
feature:
enable: true
Expand Down
8 changes: 3 additions & 5 deletions data/en/pmdk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ slider:
################################# Banner #####################################
banner:
enable: true
bg_image: ''
title: ''
content_banner:
bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository</a> on GitHub is the ultimate source from release 2.0!</p>'
text: 'The PMDK documentation collected here should be valid up to the 1.13.1 release but is maintained only on a best-effort basis and may not reflect the latest state of the art.'
bold_text: 'The [PMDK repository](https://github.com/pmem/pmdk/) on GitHub is the ultimate source of information on PMDK from release 2.0!'
text: 'For all questions and to submit eventual issues please follow to [that repository](https://github.com/pmem/pmdk/issues). The PMDK documentation collected here should be valid up to the 1.13.1 release but is maintained only on a best-effort basis and may not reflect the latest state of the art.'

################################# Libraries Section #################################
libraries_section:
Expand Down Expand Up @@ -94,7 +92,7 @@ libraries_section_deprecated:
<p>See the <a href=\"./librpmem\">librpmem page</a> for documentation and examples.</p>
<blockquote><p><strong>Note:</strong> <strong>librpmem</strong> is available only in the release 1.12.1 and before. It is no longer available on the master branch. </p></blockquote>
<blockquote><p><strong>Note:</strong> This is a <strong>deprecated</strong> API and should not be used in production environments.</p></blockquote>
<blockquote><p><strong>Note:</strong> The alternative solution for accessing remote persistent memory is implemented by <a href=\"#librpma\">librpma</a> (see above).</p></blockquote>"
<blockquote><p><strong>Note:</strong> The alternative solution for accessing remote persistent memory is implemented by <a href=\"/rpma/\">librpma</a> (see above).</p></blockquote>"
library_item8:
title: 'libvmemcache'
content: "<p><strong>libvmemcache</strong> is an embeddable and lightweight in-memory caching solution. It’s designed to fully take advantage of large capacity memory, such as persistent memory with DAX, through memory mapping in an efficient and scalable way.</p>
Expand Down
3 changes: 0 additions & 3 deletions themes/pmem-hugo/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
<!-- slider -->
{{- partial "content/slider.html" . -}}

<!-- banner -->
{{- partial "content/banner.html" . -}}

<!-- feature -->
{{- partial "content/features.html" . -}}

Expand Down
4 changes: 1 addition & 3 deletions themes/pmem-hugo/layouts/partials/content/banner.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
{{ $data := index site.Data site.Language.Lang }} {{ if $data.homepage.banner.enable }} {{ with $data.homepage.banner }}
{{ $data := index site.Data site.Language.Lang }} {{ if $data.pmdk.banner.enable }} {{ with $data.pmdk.banner }}
<div class="section m-0 border-top border-bottom py-3 information-banner-wrapper dark-mode">
<div class="container">
<div class="information-banner">
{{ .content | markdownify }}
<span class="fw-bold">{{ .content_banner.bold_text | markdownify }}</span>
{{ .content_banner.text | markdownify }}
<span class="fw-bold"><a href="{{ .download_link.link | absLangURL }}">{{ .download_link.label }}</a></span>
</div>
</div>
</div>
Expand Down
17 changes: 4 additions & 13 deletions themes/pmem-hugo/layouts/pmdk/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,8 @@ <h2 style="color: white">{{ .title | markdownify }}</h2>
{{ end }} {{ end }}


{{ $data := index site.Data site.Language.Lang }} {{ if $data.pmdk.banner.enable }} {{ with $data.pmdk.banner }}
<div class="section m-0 border-top border-bottom py-3 information-banner-wrapper dark-mode">
<div class="container">
<div class="information-banner">
{{ .content | markdownify }}
<span class="fw-bold">{{ .content_banner.bold_text | markdownify }}</span>
<p>{{ .content_banner.text | markdownify }}</p>
</div>
</div>
</div>
{{ end }} {{ end }}
<!-- banner -->
{{- partial "content/banner.html" . -}}

<!-- libraries -->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.pmdk.libraries_section.enable }} {{ with $data.pmdk.libraries_section }}
Expand All @@ -48,9 +39,9 @@ <h3 id="{{ .title }}"class="nott ls0">{{ .title | markdownify }}</h3>
<!-- libraries deprecated-->
{{ $data := index site.Data site.Language.Lang }} {{ if $data.pmdk.libraries_section_deprecated.enable }} {{ with $data.pmdk.libraries_section_deprecated }}

<div class="section m-0 bg-transparent library-section dark-mode">
<div class="section m-0 bg-transparent library-section dark-mode border-top">
<div class="container">
<div class="heading-block lib-block border-top border-bottom-0 bottommargin-sm">
<div class="heading-block lib-block border-bottom-0 bottommargin-sm">
<h3 id="{{ .title }}"class="nott ls0">{{ .title | markdownify }}</h3>
</div>
{{ .content | safeHTML }}
Expand Down
3 changes: 3 additions & 0 deletions themes/pmem-hugo/layouts/pmdk/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ <h2 style="color: white">{{ .Params.header | markdownify }}</h2>
</section>
{{ end }}

<!-- banner -->
{{- partial "content/banner.html" . -}}

<div class="section m-0 bg-transparent library-section dark-mode">
<!-- manpage shortcuts -->
{{ $dc_title := strings.TrimSuffix " | pmdk" (.Params.title | lower) }}
Expand Down

0 comments on commit 0fc0c09

Please sign in to comment.