Create automation card for Gather Data Types - Jekyll

[rblaz001]

Overview

Provide collateral for the OpenSourceAutomations.org website

Action Items

• Gather items
  • 600 x 400 image
    • Alt image text
  • Name of automation
  • A blurb about the automation
  • Links (github, slack channel url, Testing Site, Live Site, etc.)
  • Healthy project files (see resources for instructions)
    • Readme.md URL
    • contributing.md URL
    • security.md URL
    • support.md URL
• Current status of Automation
  • in use and ready to deploy
  • in use and being refactored
  • ready to deploy
  • in development
  • ready for development
  • in ideation
  • abandoned
  • If status in use, what codebase can it be seen in?
• Help wanted (check all that apply)
  • needs maintenance
  • needs support for users
  • needs refactoring
  • needs documentation
  • needs peer review
  • needs to be built
  • needs to be researched
  • needs takeover
  • needs advice
    • Advice Needed: (type short description of what you need)
• Add automation Card to website

Resources/Instructions

See project cards on the hackforla.org website for general idea, although the format of these will be different.

GitHub Guides for healthy repos

• GitHub's guide: Setting guidelines for repository contributors
• GitHub's guide: Adding a security policy to your repository
  
• GitHub's guide: Adding support resources to your project
  

Readme should include:

• Overview
  • What kind of repetitive thing do you have to do often and what is the benefit of automating it?
• Current State
  • "As-is" most likely something manual but could be partially automated
• Future Development
  • The “To-be” state
• Stakeholders
  • Impact - who benefits and how?
• Anticipated outcomes
• Resources/Instructions
  • How to run the automation and any packages or dependencies
• Language
  • Programming language(s)
• Platform
  • Where is it deployed (e.g. GitHub, Linux Command Line, Windows Command Line etc)
• Automation triggers
  • _What starts it? What's it responding to?
  • Is it Time-based (Specify frequency (e.g. 1x/week)?
  • Is it Event-based (e.g. someone just created a new GitHub on a repo)?
• Input required
  • How much manual or custom input is required?
• Output
  • What's the desired result? What do we not want to see?

[ExperimentsInHonesty]

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/)

[rblaz001]

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).

[ExperimentsInHonesty]

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

[ExperimentsInHonesty]

@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
    

[rblaz001]

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.

[rblaz001]

README requires updating to adhere to new requirements

• requires future development information

[ExperimentsInHonesty]

@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.

[ExperimentsInHonesty]

@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.

[rblaz001]

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.

[NivenPrasad]

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

[rblaz001]

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

[NivenPrasad]

@ExperimentsInHonesty will create the sample markdown file.

[ExperimentsInHonesty]

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
---

[NivenPrasad]

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

[Olivia-Chiong]

@amyflo will remove spaces and do another commit.

[Olivia-Chiong]

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

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

[henlatourrette]

This one looks to be already up and running:

[superbunker]

it totally exists