Create automation card for Gather Data Types - Jekyll about website HOT 25 CLOSED

I'm considering renaming the script and repo to Gather Data Types. I designed a logo for Gather Data Types in case I move forward with this decision.

from website.

Alt-text: "Gather Data Types Logo with Jekyll Logo on top"

Need to figure out how to follow the licencing in order to use the Jekyll logo.

Licencing Resources
https://github.com/jekyll/brand
https://choosealicense.com/licenses/cc-by-4.0/

from website.

Name of automation: Gather Data Types - Jekyll

Project blurb: This project automates identifying missing data types in Jekyll collections.

Links:

• Github: https://github.com/100Automations/jekyll-gather-data-types
• ReadME: https://github.com/100Automations/jekyll-gather-data-types/blob/master/README.md

Status: In Development

from website.

title: Gather Data Types - Jekyll
description: This project automates identifying missing data types in Jekyll collections.
image: #Need To Do
alt: "Gather Data Types Logo with Jekyll Logo on top"
#image-hero: #Need To Do
#alt-hero: #Need To Do
links: 
   - name: GitHub 
      url: https://github.com/100Automations/jekyll-gather-data-types
   - name: ReadMe
      url: https://github.com/100Automations/jekyll-gather-data-types/blob/master/README.md
status: Active

from website.

Progress - Was able to finish refactor and update README. I was also able to update repo name and logo to include Jekyll
Blockers - Need to show progress to PM and get notes
Availability: 2-3 days depending on possible job interviews
ETA: End of week at most but shooting for much sooner

from website.

@rblaz001 lets talk about blurb, I feel like we could say more. Let's work on it together. How about coming 15 min early to sunday meeting.

from website.

@rblaz001 lets talk about blurb, I feel like we could say more. Let's work on it together. How about coming 15 min early to sunday meeting.

Yeah I agree with you, I'll come up with some ideas in the meantime that might better represent the project and I will show up 15 minutes earlier to our Sunday meeting so we can go over them.

from website.

Alt Text: Jekyll logo with test tube and words Gather Data Types all in green

Name of automation: Jekyll Gather Data Types

A blurb about the automation:
When using Github and Jekyll it is easy to end up with files that are missing data types, with no built in way to enforce uniformity. The Jekyll-Gather-Data-Types automation creates reports that identify what data types are being used across all files in a collection and what might be missing from individual files in order to target code for remediation. Future functionality could include providing the option of using GitHub actions to prevent incomplete files from being committed (PRs).

Links:
Github: https://github.com/100Automations/jekyll-gather-data-types
ReadME: https://github.com/100Automations/jekyll-gather-data-types/blob/master/README.md
Contributing: https://github.com/100Automations/jekyll-gather-data-types/blob/master/contributing.md
Support: https://github.com/100Automations/jekyll-gather-data-types/blob/master/SUPPORT.md
Security: https://github.com/100Automations/jekyll-gather-data-types/blob/master/SECURITY.md

If you are looking for collaborators - What you are looking for skills wise:
Refactoring, Advice, Documentation

Status (in use, depreciated, needs update - and any other status you can think of):
In Use, Needs further Development

If status in use, what codebase can it be seen in?
Local only for security reasons

Advice Needed:
I would like some advice on how to set up a proper testing suite for my automation. We need to make sure that we can validate that jekyll-gather-data-types is working as intended.

image attribution for the Jekyll logo

Title: jekyll-logo-black.svg
Author: various, see repo for history
Source: https://github.com/jekyll/brand/
License: Creative Commons Attribution 4.0 International License (which links to http://choosealicense.com/licenses/cc-by-4.0/)

from website.

Updated blurb:

When using Github and Jekyll it is easy to end up with files that are missing data types, with no built in way to enforce uniformity. The Jekyll-Gather-Data-Types automation creates reports that identify what data types are being used across all files in a collection and what might be missing from individual files in order to target code for remediation. Future functionality could include providing the option of using GitHub actions to prevent incomplete files from being committed (PRs).

from website.

https://docs.github.com/en/articles/setting-guidelines-for-repository-contributors
https://docs.github.com/en/articles/adding-a-security-policy-to-your-repository
https://docs.github.com/en/articles/adding-support-resources-to-your-project

from website.

@rblaz001 We added some additional requirements, so I am doing a recap her of what we still need for your automation.

• Advice Needed: (type in short description of what you need)
• Healthy project files (see links for instructions)
  • contributing.md URL see GitHub's guide: Setting guidelines for repository contributors
  • security.md URL see GitHub's guide: Adding a security policy to your repository
    
  • support.md URL see GitHub's guide: Adding support resources to your project
    

from website.

Advice Needed:
I would like some advice on how to set up a proper testing suite for my automation. We need to make sure that we can validate that jekyll-gather-data-types is working as intended.

I would also like some UX advice for setting up a command line interface with menus. The current version of the script only uses flags but I am considering the use of a simple command line menu system in order to simplify user experience.

from website.

README requires updating to adhere to new requirements

• requires future development information

from website.

@rblaz001 when you say

I would also like some UX advice for setting up a command line interface with menus. The current version of the script only uses flags but I am considering the use of a simple command line menu system in order to simplify user experience.

Do you want a mockup? or some other kind of UX advice? Please specify.

from website.

@rblaz001

You could also check what Kian has written for his SUPPORT.md file https://github.com/100Automations/true-github-contributors/blob/mixin/SUPPORT.md.

We put a link in there for people to join the slack for 100Automations if they have support questions the readme doesn't answer.

from website.

Updated the SUPPORT.md file as requested and removed the UX advice requested. As discussed last Sunday the command line menu is low priority so it is to early to ask for that advice.

from website.

Hi @rblaz001, we are mocking up the automation info for the website - what programming language(s) is/are associated with your automation?

from website.

@NivenPrasad The script is written in 100% Python and the data it processes is in YAML.

from website.

@ExperimentsInHonesty will create the sample markdown file.

from website.

WIP - still needs the following

• author info
• identification #
• details about card image size (for wiki)
• discuss rollover with team. Team decision to remove rollover, not to include any looking for functionality for MVP.
• discuss status with team and camilla specifically re the chips and where they are represented on the figma
• discuss with team lock icon for as seen on.

---
# 'identification' is the 9 digit ID for your repo in the GitHub API.
identification: '286574974'

title: Jekyll Gather Data Types
description: When using Github and Jekyll it is easy to end up with files that are missing data types, with no built in way to enforce uniformity. The Jekyll-Gather-Data-Types automation creates reports that identify what data types are being used across all files in a collection and what might be missing from individual files in order to target code for remediation. Future functionality could include providing the option of using GitHub actions to prevent incomplete files from being committed (PRs).

# card image should be 372px wide x 150px high
image: /assets/images/projects/[project repo name + .jpg or .png]
alt: 'Jekyll logo with test tube and words Gather Data Types all in green'

# hero image should be 1500px wide x 700px high
# image-hero: /assets/images/projects/[project repo name + -hero + .jpg or .png]
# alt-hero: 'description of the hero image'

Authors:
- name: First Last
    links:
      slack: 'https://app.slack.com/team/U018DD0AJPJ'
      github: 'https://github.com/rblaz001'
    picture: 'https://avatars.githubusercontent.com/rblaz001'

links: 
  - name: Github
    url: 'https://github.com/100Automations/jekyll-gather-data-types'
  - name: Readme
    url: 'https://github.com/100Automations/jekyll-gather-data-types/blob/master/README.md'
  - name: Contributing
    url: 'https://github.com/100Automations/jekyll-gather-data-types/blob/master/contributing.md'
  - name: Support
    url: 'https://github.com/100Automations/jekyll-gather-data-types/blob/master/SUPPORT.md'
  - name: Security
    url: 'https://github.com/100Automations/jekyll-gather-data-types/blob/master/SECURITY.md'
  # unused links can be commented out
  # - name: Showcase deck
  #   url: ''
  #   alt: ''

looking:
  - category: Development
     skill: Refactoring
  - category: QA
     skill: Testing
  - category: Development
     skill: Documentation

needs: 
#  - maintenance
#  - support for users
  - refactoring
  - documentation
#  - peer review
#  - to be built
#  - to be researched
#  - takeover
  - advice

status:
#  - in use and ready to deploy
#  -  in use and being refactored
  - in use and needs further development (tell Camilla to add that status to the green here in [figma](https://www.figma.com/file/zGyhV8Z6sLohatYAnFoxQm/100Automations-Project-Board?node-id=175%3A2492))
#  -  ready to deploy
#  -  in development
#  -  ready for development
#  - in ideation
#  - abandoned

seen-in:
 - lock-icon

# If the card should not be included on the site, change visible to "false"
visible: true
# If the project should not have a project homepage for any given reason, add the following line (uncommented):
# project-homepage: false
---

from website.

@ExperimentsInHonesty will make a file in the repository and update the Wiki with details about the template.

from website.

@amyflo will remove spaces and do another commit.

from website.

Progress: None
Blockers: ?
Availability: ?
ETA: ?

@amyflo are you able to please provide an update for this?

from website.

This one looks to be already up and running:

from website.

it totally exists

from website.