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 annotated blog post template #27843

Closed
rolfedh opened this issue Apr 30, 2021 · 7 comments
Closed

Create an annotated blog post template #27843

rolfedh opened this issue Apr 30, 2021 · 7 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@rolfedh
Copy link
Contributor

rolfedh commented Apr 30, 2021

This is a Feature Request

Blog post contributors have issues creating new blog posts. They sometimes miss basic formatting and style recommendations.

Potential contributors might give up without trying if they have trouble finding or understanding our guidance.

Some contributors forge ahead without being aware of or following guidance. This wastes effort and goodwill during the review cycles.

Providing a template that embodies our best practices might encourage contributors, make their work easier, and produce better results.

What would you like to be added

A hugo archetype to help contributors create a blog post.

Why is this needed

To improve the ease and initial quality of blog posts. To reduce review effort and queue-time.

Comments

@rolfedh rolfedh added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 30, 2021
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Apr 30, 2021
@rolfedh
Copy link
Contributor Author

rolfedh commented Apr 30, 2021

@sftim It's important to place this template where contributors are MOST likely to see it, even if they don't read the contributor guidelines. Does the blog tooling allow a directory like the one proposed without displaying the template as a blog post?

@kbhawkey
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 30, 2021
@sftim
Copy link
Contributor

sftim commented May 4, 2021

I would use an archetype for this, and mention the archetype in the README etc.

@rolfedh
Copy link
Contributor Author

rolfedh commented May 4, 2021

I would use an archetype for this, and mention the archetype in the README etc.

Sounds like a good idea. I'll give it a try.

k8s-ci-robot added a commit that referenced this issue Jul 9, 2021
@nate-double-u
Copy link
Contributor

Fixed in #27971

/close

@k8s-ci-robot
Copy link
Contributor

@nate-double-u: Closing this issue.

In response to this:

Fixed in #27971

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@cittizen-poey
Copy link

hi how I make a portfolio website

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

6 participants