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

Issue 241 #248

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

milovanderlinden
Copy link
Contributor

Issue: #241

Approach

  • Generate a static code.json file in the _data directory with the script src\_plugins\code_json_generate_once
  • added the script src\_plugins\data_page_generator.rb taken from https://github.com/avillafiorita/jekyll-datapage_gen this script will generate individual pages per project
  • Updated navigation
  • Created a projects page

Please review

Copy link
Contributor

@jordangov jordangov left a comment

Choose a reason for hiding this comment

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

Thanks again for the contribution @milovanderlinden! Since this is your first submission, can you please add your name to the contributors list? This also means that you are agreeing to the terms of the Developer Certificate of Origin (DCO) that is linked on that page. Let us know if you have any questions.

<p>
{{ page.description }}
</p>
<p>Status: {{ page.status }}</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, thinking this might be a <ul>? They're not really paragraphs :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am open to all suggestions. If you are sure you want me to change it to

    I will.

<p>Organization: {{ page.organization }}</p>
<p>Source: <a href="{{ page.repositoryURL }}">{{ page.repositoryURL }}</a></p>
<p>License: <a href="{{ page.permissions.licenses[0].URL }}">{{ page.permissions.licenses[0].name }}</a></p>
<p>Contact: <a href="mailto://{{ page.contact.email }}">{% if page.contact.name %} {{ page.contact.name }} {% else %} email {% endif %}</a></p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be page.contact.email in the displayed portion of the link (when there is not contact name)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are situations in the code.json file where there is an email, but not a name. But I will enhance this with a check for email too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Enhanced it with a couple of checks as there is some pollution in the data

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I meant at the end... it says {% if page.contact.name %} {{ page.contact.name }} {% else %} email {% endif %} and my question was, at the end there, should that be page.contact.email? Like this:

{% if page.contact.name %} {{ page.contact.name }} {% else %} {{page.contact.email}} {% endif %}

Just a thought. I guess I'm open to either just the word "email" or the actual email...

src/projects.md Show resolved Hide resolved
@@ -0,0 +1,13 @@
---
title: Projects
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is a good start, but I'd like to see a bit more style and layout on this page before we push it. Maybe add a couple more details to this list? Perhaps we could steal the layout/styles of the Code.gov browser projects page?

src/_plugins/code_json_generate_once.rb Show resolved Hide resolved
src/_plugins/data_page_generator.rb Show resolved Hide resolved
layout: null
permalink: code.json
---
{{ site.data.code | jsonify | strip_html}}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a possible solution to not having two code.json files created through two different generators.

@jordangov
Copy link
Contributor

@david-saeger Why did we close this PR? Do you think it is not viable as an option to resolve the user-friendly project inventory?

@david-saeger david-saeger reopened this Aug 21, 2023
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.

3 participants