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 documentation/readme template info for PM's to make sure project info populates to card component from repos #118

Open
2 tasks
zenlex opened this issue Oct 15, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@zenlex
Copy link
Collaborator

zenlex commented Oct 15, 2022

We need to create a markdown template file with frontmatter fields that match all the needed data on the project cards field. This will serve as the template for all Organization readmes going forward. Will accept PRs for each task (be sure to check for existing branch). **Frontmatter should also contain a content-type: project field and a publish: true|false

  • create blank PROJECT_README_TEMPLATE.md with the frontmatter fields needed for project card data. See Create Project Card component #76
  • Look at Courtbot sample md files and add default headings and any other common styling/structure that makes sense for a typical civic tech project (look at other code for tulsa repos or other code for america projects for examples. Feel free to steal from this repo's readme as a starting point also).
@zenlex zenlex added hold putting this pr/issue on pause pending discussion documentation Improvements or additions to documentation good first issue Good for newcomers and removed hold putting this pr/issue on pause pending discussion labels Oct 22, 2022
@vivian-tse
Copy link

I can work on this.

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 good first issue Good for newcomers
Projects
Status: Selected for Development
Development

No branches or pull requests

2 participants