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 an Issue Template: Suggest a Guide #57

Closed
3 tasks done
NivenPrasad opened this issue Nov 14, 2020 · 6 comments
Closed
3 tasks done

Create an Issue Template: Suggest a Guide #57

NivenPrasad opened this issue Nov 14, 2020 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation p-feature: guides role: product

Comments

@NivenPrasad
Copy link
Contributor

NivenPrasad commented Nov 14, 2020

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

@NivenPrasad NivenPrasad added documentation Improvements or additions to documentation role: product labels Nov 14, 2020
@NivenPrasad NivenPrasad added this to the Design MVP milestone Nov 14, 2020
@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Nov 19, 2020

TEMPLATE

Default title of issue is: "Suggest a guide: [name of guide here]

Default labels: feature: guides, documentation


Special note: please make sure you have read this guide: [insert guide url when its available]

Include the following information:

What would the title of the guide be?

Example: Write a Short Narrative Description about Your Automation

What would the description of the guide be?

Example: A good narrative description will increase targeted traffic to your repository. This guide helps you create one.

Who needs this guide?

  • Software developers of all skill levels
  • People with ideas for automation
  • People looking for automations (Project Managers, Business Analysts, Portfolio Owners)
  • Employers
  • Open source advocates
  • Product Managers

Screen Shots or other images

If you have any images (screen shots or other) that you think would be helpful, please put them in this issue, and if not screen shots, please indicate licence type of image and where it came from (link). Only images that are creative commons can be used on our site, except where the author allows non commercial use with attribution on our credits page.

Additional Resources

Example: a link to a github tutorial or wiki file, etc.

Credit

We like to give credit where credit is due. Good ideas and their execution are both important. Please indicate how would you like to be credited and if you want to be consulted on edits (if applicable).
Name?
Github Handle?
LinkedIn profile?
etc?

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Nov 19, 2020

@NivenPrasad Please add a list of the people we serve as a check list and whatever else you think this needs and format how you like before creating a new template issue in the website repo.

@ExperimentsInHonesty ExperimentsInHonesty changed the title Create a "Suggest a Guide" Form Create a "Suggest a Guide" Issue template Nov 29, 2020
@ExperimentsInHonesty
Copy link
Member

  • Software developers of all skill levels
  • People with ideas for automation
  • People looking for automations (Project Managers, Business Analysts, Portfolio Owners)
  • Employers
  • Open source advocates
  • Product Managers

@ExperimentsInHonesty ExperimentsInHonesty changed the title Create a "Suggest a Guide" Issue template Create a Issue template: Suggest a Guide Nov 29, 2020
@ExperimentsInHonesty ExperimentsInHonesty changed the title Create a Issue template: Suggest a Guide Create a Issue Template: Suggest a Guide Nov 29, 2020
@NivenPrasad
Copy link
Contributor Author

@ExperimentsInHonesty this looks good. Minor edit but I think that the "Credit" title might be better as "Credit for Published Guide" as some people with a ready automation will come looking straight for that use case and so this directs them there more quickly.

@NivenPrasad
Copy link
Contributor Author

In progress: @NivenPrasad working on it
Blocks: none
Eta: Saturday

@NivenPrasad NivenPrasad changed the title Create a Issue Template: Suggest a Guide Create an Issue Template: Suggest a Guide Dec 12, 2020
@NivenPrasad
Copy link
Contributor Author

Here is the PR to merge the template.

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: product
Development

No branches or pull requests

2 participants