Code Monkey home page Code Monkey logo

pmem.github.io's Introduction

pmem.github.io

pmem.io web site

This repo contains the top-level content for the pmem.io website.

Files on the “main” branch of this repo contain the source which is run through Hugo automatically when changed via the GitHub Actions configuration in:

.github/workflows/gh-pages.yml

The result is deployed to the “gh-pages” branch (so you should not edit those files Directly or they will be overwritten by the next deployment).

Most of the basic content is under data/en, for example, the content for the URL

https://pmem.io/about/

is in the file:

data/en/about.yml

The contents of this site are BSD-licensed open source.

Send questions or comments to [email protected].

pmem.github.io's People

Contributors

acconut avatar andyrudoff avatar ashaw596 avatar bratpiorka avatar grom72 avatar hubertsoltysiak avatar igchor avatar janekmi avatar jemclaurin2022 avatar jschmieg avatar kilobyte avatar krzycz avatar kswiecicki avatar ldorau avatar lplewa avatar lukaszstolarczuk avatar maciekpac avatar marcinslusarz avatar osalyk avatar patkamin avatar pbalcer avatar plebioda avatar pmem-bot avatar robdickinson avatar sscargal avatar stellarhopper avatar szadam avatar tomaszkapela avatar wlemkows avatar xiao1chen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pmem.github.io's Issues

Unify tags and categories

Blog posts, announcements, videos (and other sections with tags and categories) should unify naming and grouping.

Right now (especially blog posts) are "randomly" added to categories. I believe this should be updated and unified, e.g., for easier usage like on /pmemstream: https://pmem.io/pmemstream#blog-entries

We may easily point to all posts/announcements/videos/... on selected microsties.

When the unification is done, we should also update the archetypes with proposed categories... or maybe we should list somewhere what's proposed (e.g. in README or in CONTRIBUTING files).

Add content author's link

Add links to GitHub for authors of the content. Right now we only state the author by their name. We could also add a link to GH profiles, based on a login delivered as a separate metadata, e.g., in blog content.

# Blog post creation date
date: 2022-01-26

# Blog post author and GH link
author: "Łukasz Stolarczuk"
gh-link: lukaszstolarczuk

I believe this would be a nice addition and could make a way for readers to contact us easier.

It applies to all archetypes, which inform about the content's user.

Extend FAQ section

Our FAQ page is rather empty. Perhaps we should make more out of it, so if the user asks a repeated question, we could just link them here for a well-written, ready answer.

https://pmem.io/faq/

[Bug] Search does not work

Try to use the search button at the top of the webpage.
In result, I got the following message:

Search results
Unable to execute your query. Ensure that a valid subscription key has been set up for your instance.

pmemkv manpages does not have links to other manpages

On the pmemkv's manpage, there are no links to other manpages available for selected release. It should be done using layouts/shortcodes/manpages.html script available in the repository. This script perhaps requires some modifications to work properly with pmemkv.

Usage example:
{{< manpages >}}
see e.g. here:
https://github.com/pmem/pmem.github.io/blob/main/content/pmdk/manpages/linux/master/libpmem/libpmem.7.md

Other thing to check is missing metadata in pmemkv's manpages - header: "..."
or additional (perhaps redundant) layout: "library".

Wrong link for Valgrind in Developer Hub

I believe we may update the link on the Developer Hub (tools section, down below) to point to our version of valgrind instead of the upstream one. We may update the content of the valgrind section to inform users it's our fork (with pmemcheck support).
Pmemcheck is listed as a separate tool, so maybe their description could be updated (for a clear statement what is what 😉 ).

The content of valgrind's microsite (https://pmem.io/valgrind) could also mention it's a fork + a link to the upstream repo.

Define new content view for 'library'

Each new repository that would like to have a separate microsite (sub-page) is required to write single.html and lists.html views. We should probably define a new content view "library", re-name/remove existing views, and most likely, unify 'single' view for all our microsites (required for articles/manpages/...).

We have to copy-paste now, quite a lot of content for a new library's microsite.

Perhaps it'd be also possible to create a new archetype to simplify creation of a new microsite.

Update baseURL on forks

Our web sites, built from forks do not work 100% properly - links ref to "pmem.io" instead of "myfork.github.io", which is not ideal for testing and providing a preview (for review, on PR). It's because of hardcoded baseURL in our config.toml and CNAME (?).

Ref. to the discussion in PR: #181 (comment) and mentioned there a link with a proposed solution:
rstudio/blogdown#412

Update PMDK sub-page in Developer Hub

We may, most likely, want to update the Developer Hub, to avoid looking for, e.g., 'RPMA' within PMDK section. I believe we should have a separate section for all repositories independent from PMDK repository.

Some of the descriptions within the PMDK page should probably be also updated with more/up-to-date content.

Perhaps repositories that will move out (to a separate sub-page with a link in Dveloper Hub) should be removed or just clearly stated that they are not part of the PMDK repo (links for backward compatibility would be nice - there is a possibility to specify
a link to a section within PMDK web page).

Broken links

Describe the bug
Some links on pmem.io doesn't follow to any page.

To Reproduce

  1. install broken-link-checker
  2. run it against pmem.io
blc --exclude glossary -ro https://pmem.io

Log
broken_links.log

Additional context

  • broken-link-checker returns some false positives, especially for external links with redirection.
  • On my machine, check for glossary page takes long, that's why I excluded it.
  • It may be useful to create weekly CI job to check links.

[Bug] Fix typo in Memkind lib name

Describe the bug
Developer Hub -> MemKind link should be renamed to "Memkind" (without capital K)

How often is the bug experienced?
Always

Bug Severity
Based on the frequency and how it impacts you and others, do you consider the issue to be high, medium, or low severity?

  • High
  • Medium
  • Low

Website URL
https://pmem.io/blog/

To Reproduce
Steps to reproduce the behavior:

  1. Go to Developer Hub
  2. See "MemKind" instead of "Memkind"

Add previews of recent content, related to the project on its microsite

It would be best to display all/recent blog posts (or announcements, videos, tutorials, ...) related to a selected project.
For example, instead of just adding a link to the category "pmemstream" on its microsite (https://pmem.io/pmemstream#blog-entries), it'd be better to display the most recent blog posts (as thumbnails) with the link to other related posts.

It should be done similarly to, e.g., "News and announcements" section on the home page.

It applies to (at least): PMDK, pmemkv, memkind, libpmemobj-cpp, pmemstream

[Bug] Replace "MemKeyDB" link with link to TieredMemDB

Describe the bug
In "Developers Hub" there is a link to "MemKeyDB" project. It should be replaced with a link to TieredMemDB (https://tieredmemdb.github.io/TieredMemDB/)

How often is the bug experienced?
Always

Bug Severity
Based on the frequency and how it impacts you and others, do you consider the issue to be high, medium, or low severity?

  • High
  • Medium
  • Low

Website URL
https://pmem.io/

To Reproduce
Steps to reproduce the behavior:

  1. Click on 'Developers Hub'
  2. See link to "MemKeyDB" instead of TieredMemDB (https://tieredmemdb.github.io/TieredMemDB/)

Add line numbering in code snippets by default

We could add line numbering for code snippets/highlighting as default param in hugo.

Right now, because of using syntax, e.g. like:

```c++

we lose line numbering. We can make it appear by using syntax like:

{{< highlight C "linenos=table" >}}
{{< /highlight >}}

But then the code highlighting does not work well in IDE (at least in mine 😉 ).

ref. #270

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.