100automations / website Goto Github PK

We’re supporting tools and micro services to help simplify open source development for the wider Civic Tech community. We welcome ideas and projects in all stages - connect with us and let’s build 100 automations.

Home Page: https://100automations.org/

License: GNU General Public License v3.0

HTML 50.57% SCSS 49.43%

hack-for-la civictechindex

website's Introduction

100 Automations Website

100 Automations is a project of Hack for LA that showcases automations and microservices that reduce repetitive work in open source development; a project where anyone can create, collaborate on, and get credit for high-value open source contributions to the wider Civic Tech community. The name derives from the project’s goal to reach 100 developed automations in our first twelve months.

The 100 Automations website is going to be a standard Jekyll site hosted right here on GitHub pages. We will be providing further instructions after we have our first initial code.

Project context

For more information on the project development, refer to: 100 Automations Project One Sheet. You can also read more about our project on our Wiki.

Technology used

GitHub: Project Management Board and Future Automations
Slack: #100automations channel
Jekyll

How to contribute

Help us build the website to showcase the automations

The roles we are currently looking to fill are:
- UI Designer (must have)
- Content Writer (nice to have)
To join the team, join the Hack for LA slack: invite yourself here and reach out to our Product Manager, Niven Prasad, on our Slack
Review our Project Management Board
Weekly team meetings are at Wednesday at 4:30 pm PST and Saturdays at 2pm PST on via Zoom

Start automating

Find an automation that you want to build from our list of ideas: some are half baked and need more research, others are well documented
Propose a new idea for an automation
Tell us about an automation that you have already built that you would like to host here

website's People

Contributors

Stargazers

Watchers

Forkers

mdothman experimentsinhonesty driffathsultana mcspach jbubar stellaliao01 akibrhast nivenprasad c-arvind spencerleemeredith the-blockchain-studies-page sadabjr akilah-littlejohn

website's Issues

Update Readme for futureautomations

Overview

The futureautomations Readme needs an update so that people who want to contribute to the futureautomations repository know how the project flow works.

Dependency #117 #118

Action Items

Identify what the workflow is
Write the futureautomations Readme and the guide as appropriate
Review with Product Team

Resources/Instructions

futureautomations Readme
Open Issue Create Guide: Create or Publish Your First Automation

Create a Guide: Supporting Your Automation with Community

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Supporting Your Automation with Community" guide.

Action Items

Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name: community-support-for-automations.md
- Add the following header to the file:

---
title: Supporting Your Automation with Community
description: In order to save time and provide a consistent experience for creators and users we’ve created default health files for you to customize as appropriate to your project. 
status: active
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design

Create a logo for 100 Automations

Overview

We need to create a logo for the project.

Action Items

Resources/Instructions

Project Figma Board

Create automation card for Pre-commit-hook-starter

Overview

Provide collateral for the OpenSourceAutomations.org website

Action Items

Resources/Instructions

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

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?

Final Action Item

Release the dependency #73

Identifying the OKR's

Overview

We need to collaborate on identifying how best we will measure the successes using milestones and measurable results.

Action Items

Identify overview of steps for Niven and Bonnie to review
- Team independently reviews Abi's doc.
Meeting with Team (Bonnie, Abi and Niven)
- Drafting set of OKRs
- Abi to identify the availability of Niven and Herself via slack dialogue
- Set meeting time and invite Bonnie
Review OKRs with Joel

Resources

OKR Document-https://www.whatmatters.com/articles/okrs-positive-social-change-nonprofit/

https://www.bernardmarr.com/default.asp?contentID=1456

CfA Aug 12 workshop

CfA Slides from Aug 12 workshop

Create automation card for True GitHub Contributors

Overview

Provide collateral for the OpenSourceAutomations.org website

Action Items

Resources/Instructions

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

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?

Create a Guide: Your Automation Beyond 100 Automations

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Your Automation Beyond 100 Automations" guide.

Action Items

Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name: automation-beyond-100automations.md
- Add the following header to the file:

---
title: Your Automation Beyond 100 Automations
description: What are your options for your automation after it's been published on 100 Automations? Here we set out the directions it can take and how to take those directions. 
status: active
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design

One-sheet for project

Overview

Write a one-sheet for the 100Automations project including milestones for the next 6 months.

Action Items

Review VRMS one-sheet
Review Civic Opportunity Project one-sheet
Produce First Draft of 100Automations project
Prepare questions for review with Bonnie

Resources/Instructions

All project one-sheets

Validate information collection from automation creators for website content

Overview

We need to review the information we intend to collect from automation creators, so that we can present each automation in a way that is valuable to our audience

Action Item

Review the template below with Automation Creators on the Ops group, and identify any additional information they would like to see.
- Update the template
Review the template with Automation implementers e.g. people outside our organization or otherwise

Resources

Ops team meeting, Tuesday 8pm PDT zoom link
TDM Calculator meeting, Wed 7pm PDT Zoom link

### 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.)
  - [ ]  Any resources for a Getting Started link (a link to a wiki, readme(s) or both)
  - [ ]  If you are looking for collaborators - What you are looking for skills wise
  - [ ]  Status (in use, depreciated, needs update - and any other status you can think of)
     - [ ] If status in use, what codebase can it be seen in?
- [ ]   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.

Make health files in the .github-automations repo

Overview

We need to make default health files in the .github repo so that developers for new automations don't need to create new ones when they set up an automation

Action Items

Create default support.md file
Create default contributing.md file
Create default security.md file

Resources/Instructions

See true-github-contributors repo for example

Decide/develop our own style guide

Overview

Develop style guide for the overall navigation and visual appearance of the site.

Action Items

Define a color guide
Define a typography system
Create key components

Resources/Instructions

Figma File: https://www.figma.com/file/zGyhV8Z6sLohatYAnFoxQm/100Automations-Project-Board?node-id=243%3A363
Reference to Hack for LA Figma

Update logos on social media

Overview

We need to update the logos and banners on social media accounts.

Action Items

Update Facebook account logo
Update Facebook account background
Update Instagram account logo
Update YouTube account logo
Add YouTube account background (we don't have one yet, but we can add one)
Update GitHub account
Update Twitter account logo
Update Twitter account background

Resources/Instructions

Logo Variants in Figma Board

Marketing review of mvp site content plan

Overview

Identify what marketing assets we need to support the project objectives

Dependancy

#78

Action Items

Ask Marketing what content needs to be added to the website to support its marketing efforts
Ask Marketing to review the activities we are trying to support

Background

100 Automations website will be public facing.
It is in MVP site design at the moment and we were about to turn it over to development soon when we realized that we had not asked what would we need in order to promote this, and where that should that live on the site.

The types of activities we want to support from the start:

Individual contributors who are publicizing the automations that have been launched on our website
People who hear about the idea and want to promote it
Press that want to feature it
Promotion we will do ourselves (initial site launch, recruiting for developers to do automation submissions, hitting milestones on our way to our goal, etc.)

Resources/Instructions

Current site design in Figma

Press kit page: https://www.figma.com/file/zGyhV8Z6sLohatYAnFoxQm/100Automations-Project-Board?node-id=791%3A30

Write copy for the website

Overview

Copy for the website

Dependency

Requirements gathering milestone complete

Action Items

Review requirements summary document
Write draft language for design process

Resources/Instructions

Requirements summary document

Create site map with UI/UX navigation flow

Overview

We need to create a flexible structure for the website to accommodate MVP requirements and growth beyond.

Dependency

Requirements gathering summary Issue #25

Action Items

Resources/Instructions

Social Media Assets

Overview

We will drop-in any assets used for our social media channels.

Resources/Instructions

Twitter Image
Facebook Image
Instagram Image

Create automation card for Gather Data Types - Jekyll

Overview

Provide collateral for the OpenSourceAutomations.org website

Action Items

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

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?

Memes for Social

Overview

We need some clever memes for social.

Action Items

List all pain points that 100 Automations is designed to solve
Add brief text that describes the pain and the solution in a pair

Resources/Instructions

Requirements Doc
Project One-sheet
All documentation tickets

Create personas

Overview

Create personas for the users of the website and GitHub workflow.

Action Items

Create Google Doc with User Personas
Review with Bonnie

Resources/Instructions

Notify VRMS of 100Automations' Team Meeting Times

Overview

VRMS needs to know details of 100Automations' weekly team meetings

Cloudflare login

Identify Audience for website and create personas

Overview

We need to know who we are designing this website for

Action Items

Review the one sheet and pull out all the audience types and put in this issue
Identify audiences we have not named
Review with Bonnie
Review with Creators
Identify other people to ask including ops group
Create personas from validated user groups

Resources/Instructions

https://github.com/100Automations/Website/blob/master/100Automations_Project_One_Sheet.pdf

User Journey Mapping Doc

Write a Press Release

Overview

We need to write a press release for the project. We have a Press Kit page and a Press Release, Bio, and Fact Sheet section. We need to write a press release to add to it.

Action Items

Confer with marketing team to find out what content should be included in the press release.
Interview team members for the relevant information
Write a draft
Get it reviewed by product
Get it reviewed by marketing

Resources/Instructions

Slack #hfla-marketing Elle Wheeler
Project one pager
Final Press Release

Update Team Roster

Overview

Rolling roster of team participants.

Action Items

Add or update your info into the team roster.

Resources/Instructions

100 Automations Team Roster

Write Project Requirements Summary Document

Overview

We need a requirements summary to share with website design and to complete the initial requirements gathering milestone.

Dependency

Requirements gathering milestone complete

Action Items

Review all the items in the requirements gathering milestone
Write summary
Review with Bonnie
Close issue and check to make sure milestone shows as completed

Resources/Instructions

Create social media accounts for 100automations

Overview

Create social media accounts for 100automations.

Action Items

Set up accounts for:

Twitter
Instagram
Facebook

Resources/Instructions

Get setup on 1password

Overview

We need to add our 100 Automations passwords to the password system that Hack for LA uses so that they can be available for the organization.

Action Items

Read this draft: hackforla/website#701 (comment)
Prepare a list of accounts and passwords that we will need to store
Work with Bonnie to get setup on the system
Follow instructions in the document and identify if any of the instructions could be improved. Put revised draft in issue.
- Take screen shots of any screen that would be useful. Put screen shots in this issue.

Resources

https://hackforla-team.1password.com/

Landing page to capture user personas

Overview

We need to create a landing page to capture which profile of visitor is visiting our page. Depending on their profile, the page will then dynamically render.

Action Items

Review user personas
Mock-up landing page
Reviews with team

Resources/Instructions

User personas

Create a default Code of Conduct file in .github

Overview

A Code of Conduct file is necessary for repos to meet community health standards. We need to create a default one so that any automations include this as part of their repo.

Action Items

Craft a Code of Conduct file that links to the Hack for LA code of conduct and create a default file in the .github repo

Resources/Instructions

Hack for LA Code of Conduct

Create a Guide: Preparing Your Automation for Publication

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Preparing Your Automation for Publication" guide.

Action Items

Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - prep-automation-for-publication.md
- Add a header to the file

---
title: Preparing Your Automation for Publication
description: Gather the items in this guide before submitting your automation for publication.
status: active
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design

Update ReadMe

Overview

We need an up to date ReadMe to communicate effectively new users, contributors, and visitors on a continuous basis.

Dependency

Waiting for automation template issue #13 to get resolved.

Action Items

Once that happens, update link in ReadMe to the template
New person to review ReadMe identifying unanswered questions that could be addressed
- Post suggestions in the comments below

Resources/Instructions

Here is the draft ReadMe for Website repo for your review.
Website ReadMe

Create an Issue Template: futureautomations automations creators submissions

Overview

An issue template for automation creators to use to ensure a minimum quality standard for automations as it makes its way through the creation workflow.

Action Items

Review templates for current automation ideas
Draft a template here in the comments
Review with various
Add to the futureautomations repo

Resources/Instructions

futureautomations repo

Create a Guide: Creating a Good Read.me for Your Automation

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Creating a Good Read.me for Your Automation" guide.

Dependency

Waiting for other guides to be done to see if this needs any additional formatting.

Action Items

Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name: creating-good-readmes-for-automations.md
- Add the following header to the file:

---
title: Creating a Good Read.me for Your Automation
description: a read.me file is usually the first place that developers will start. It should be fairly comprehensive and should have links to the other health files.
status: active
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design

Create Guide: Evaluating A New Automation Idea

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Evaluating A New Automation Idea" guide.

Action Items

Content

Write a draft outline

Product

Paste mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name:
- Add a header to the file and add the name of guide where it says title

---
title:
description:
status: coming soon
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design
Automations Proposal Template

Create an Issue Template: Suggest a Guide

Overview

We need to create a "Suggest a Guide" form/issue - there is a card on the website called "Suggest a Guide" that when clicked on, should take the user to this form.

Dependency

This template issue will have to be created and then the guide can be created and the template issue edited to link to the guide page until there is a real guide on the site.

Action Items

Create the text for template as a comment in this issue
Review with Bonnie
Create as a template in the website repo

Resources/Instructions

Create a guide: Writing an Article about your Automation

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Writing an Article about your Automation" guide.

Action Items

Review True GitHub Contributors article outline and create a guideline for how to write an article
Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name: writing-articles-for-automations.md
- Add the following header to the file:

---
title: Writing an Article about your Automation
description: 
status: coming soon
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design
Reference articles for what should be in the article
True GitHub Contributors article outlines

Update Readme for website

Overview

Readme needs an update so that people thinking about joining our project know how to contribute.

Action Items

Review the readme resource and figure out what we can include in ours. Also look at the one for civic opportunity as an example
Update our readme
Send to Bonnie for review

Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name: writing-short-descriptions-for-automations.md
- Add the following header to the file:

---
title: Write a Short Narrative Description about Your Automation
description:  A good narrative description will increase targeted traffic to your repository.  This guide helps you create one.
status: active
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design

Create a guide: Writing a Technical Description for Your Automation

Overview

We need to create website content with a mark-down approach so that development can be easily updated. This is the issue to create a mark-down file for the "Writing a Technical Description for Your Automation" guide.

Action Items

Write mark-down for the guide instructions in a comment on this issue.
Create a mark-down file for this guide and add it to a folder called _guides
- Call the file a name with dashes that is as short as possible
  - name: writing-technical-descriptions-for-automations.md
- Add the following header to the file:

---
title: Write a Short Technical Description about Your Automation
description:
status: coming soon
display: true
---

Resources/Instructions

Figma Board for 100 Automations Website Design

Social Media previews

Overview

We need preview images for each automation and for our own website repo

Action Items

Resources/Instructions

Research other open source automation repos on GitHub

Overview

Find out how other open source automation repos approach creating automations to see what we can implement with our own automations.

Action Items

Search Github for 3-4 open source automation repos
Fill out competitive analysis template

Resources/Instructions

Competitive analysis template

Example of competitor

Role Identification

Overview

We need to build a team for the 100Automations site.

Action Items

Review the roles document
Identify initial list
Add requirements to current needs doc

Resources/Instructions

General Role Definitions

Project Recruiting Current Needs

Role Recruitment

Overview

We need to recruit contributors for this project on an ongoing basis.

Note

Last comment on this sheet will have our current recruiting needs listed.

Action Items

Check last comment on recruiting sheet and update as necessary
If updates made, update spreadsheet

Resources/Instructions

Create sketches for website pages

Overview

We need initial sketches for the website pages.

Action Items

Review Figma Board for outline of content for 5 pages
Produce first sketches of pages
Review with team

Resources/Instructions

Project Figma Board