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

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

Closed
5 tasks done
NivenPrasad opened this issue Oct 7, 2020 · 2 comments
Closed
5 tasks done

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

NivenPrasad opened this issue Oct 7, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation p-feature: guides role: content writing

Comments

@NivenPrasad
Copy link
Contributor

NivenPrasad commented Oct 7, 2020

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

@NivenPrasad NivenPrasad added this to the Design MVP milestone Oct 7, 2020
@NivenPrasad
Copy link
Contributor Author

NivenPrasad commented Oct 10, 2020


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

Creating a Good Read.me for your Automation

Example

See an example of a good 100 Automations Read.me: True GitHub Contributors

Instructions

A good 100 Automations Read.me should have the following content:

# Title

## Overview
What kind of repetitive thing do you have to do often and what is the benefit of automating it?

### Problem Being Solved

### Value Created from Solution

### Solution (simplified explanation)

### Stakeholders
Impact - who benefits and how?

## Technical Details
### Installation

### Current State
"As-is" most likely something manual but could be partially automated

### Future Development
The “To-be” state

### Anticipated technical 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
Time-based (Specify frequency (e.g. 1x/week)
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 expected result? 

## API
(If applicable)
### Versions/Updates
### Configuration
### Usage
### Endpoint documentation

@NivenPrasad NivenPrasad changed the title Create Mark-down Files to Preview for Formatting Website Pages Mark-down file Preview - Guide 1 - Creating a Good Read.me for Your Automation Oct 10, 2020
@NivenPrasad NivenPrasad changed the title Mark-down file Preview - Guide 1 - Creating a Good Read.me for Your Automation Create a Guide: Creating a Good Read.me for Your Automation Oct 10, 2020
@NivenPrasad NivenPrasad added role: content writing documentation Improvements or additions to documentation labels Oct 10, 2020
@ExperimentsInHonesty
Copy link
Member

@NivenPrasad I think this is page is good to make a file out of now. So when we next get together I can walk you through it. And then once this one is done, we will have a url to insert into #43 and it can go live as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation p-feature: guides role: content writing
Development

No branches or pull requests

2 participants