Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: first draft to display meta data #20

Merged
merged 8 commits into from
Apr 25, 2018
Merged

Feature: first draft to display meta data #20

merged 8 commits into from
Apr 25, 2018

Conversation

googol42
Copy link
Contributor

@googol42 googol42 commented Apr 20, 2018

  • Add support for meta data.

The html is not perfect. But IMO for the Prozessanalyse sufficient.

The syntax includes everything which was required/discussed on 27th March (sources, author name, author url, reviewers' names/company/..., link to reviewers' webpage, reviewed commits). Security Features can be realized by using tags.

Syntax for md files, here as part of java_easy_AES_string_encryption.md:

---
title: Java String Encryption using JDK
keywords: sample
summary: "Java based string encryption"
permalink: java_easy_AES_string_encryption.html
folder: Java JDK
tags: [Java, AES, GCM, PBKDF2, Salt, AEAD]
references: [
    {
        url: "https://docs.oracle.com/javase/7/docs/api/",
        description: "JavaDoc API"
    }, {
        url: "https://www.google.de",
        description: "Yeah! Google as source."
    }
]
last_updated: "2018-04-21"
authors: [
    {
        name: "Herr Mustermann",
        url: "https://herr-mustermann.com"
    },
    {
        name: "Frau Musterfrau",
        url: "https://frau-musterfrau.com"
    }
]
current_reviews: [
    {
        name: "Sascha Security",
        url: "https://github.com/master-security",
        reviewed_commit: "https://github.com/kmindi/CryptoExamples/commit/6fa03d7a38c06ac69ce639a503fa947a99c3d168"
    }, {
        name: "Sascha Security Security ",
        url: "https://github.com/master-security2",
        reviewed_commit: "https://github.com/kmindi/CryptoExamples/commit/497ea81805ce9e14e1005171c3a6df444a5aa2e3"
    }
 ]
---

Yields this page:

bildschirmfoto_2018-04-24_16-16-52

@googol42 googol42 requested a review from kmindi April 20, 2018 12:47
@googol42 googol42 changed the title WIP: Feature: first draft to display meta data Feature: first draft to display meta data Apr 20, 2018
Copy link
Collaborator

@kmindi kmindi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I have only a few remarks:

  • Move everything below the example, so the example stays the first thing to bee seen.
  • Don't use h2, but a less big heading.
  • I'd expect the source code under the heading "sources" not the references
  • I'd expect "Version History" instead of "changes to this example"
  • I'd expect reviews to be a separate heading.

@googol42
Copy link
Contributor Author

googol42 commented Apr 24, 2018

@kmindi As discussed. The jekyll-last-modified-at plugin is not available on github page (github/pages-gem#119) So, one have to enter the date oneself. However, I copy this value to site.last_updated which then displays the date in the footer.

Note, the spelling mistake in the screenshot was fixed (Reviewes). If you like to have other names for the headings, feel free to change them on this branch.

@googol42 googol42 requested a review from kmindi April 24, 2018 14:25
{% assign site.last_updated = page.last_updated %}
{% if page.references %}
<ul>
<h3>References</h3>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move outside of ul

{% endif %}

{% if page.current_reviews %}
<h3>Last Reviews</h3>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviews (not Last Reviews)

@googol42 googol42 requested a review from kmindi April 24, 2018 15:28
@kmindi kmindi merged commit 4358682 into master Apr 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants