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

Revise blog submission guidelines for the new "author" metadata format #46821

Open
dipesh-rawat opened this issue Jun 14, 2024 · 4 comments · May be fixed by #46866
Open

Revise blog submission guidelines for the new "author" metadata format #46821

dipesh-rawat opened this issue Jun 14, 2024 · 4 comments · May be fixed by #46866
Assignees
Labels
area/blog Issues or PRs related to the Kubernetes Blog subproject help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@dipesh-rawat
Copy link
Member

This is a Feature Request

What would you like to be added
The blog submission guidelines (here) currently do not reflect the new format required for front matter, particularly the inclusion of author metadata. This discrepancy could lead to confusion and incorrect submissions from contributors who follow the outdated format. The existing guidelines need to be updated to reflect this change.

Proposed Solution:
Update the example front matter on the blog submission guidelines page (here) to demonstrate the correct format for including author metadata. Ensure that any related content, such as instructions or explanations surrounding the addition of author information, is also updated to reflect the new requirement.

---
layout: blog
title: "Your Title Here"
date: YYYY-MM-DD
slug: text-for-URL-link-here-no-spaces
author: >
  Author-1 (Affiliation),
  Author-2 (Affiliation),
  Author-3 (Affiliation)
---  

Page to Update:

Additional Information:
/language en
/sig docs
/area blog

@dipesh-rawat dipesh-rawat added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 14, 2024
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. area/blog Issues or PRs related to the Kubernetes Blog subproject needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 14, 2024
@sftim
Copy link
Contributor

sftim commented Jun 14, 2024

/triage accepted
/help

@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/triage accepted
/help

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 14, 2024
@sftim
Copy link
Contributor

sftim commented Jun 14, 2024

/priority backlog

@k8s-ci-robot k8s-ci-robot added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Jun 14, 2024
@arujjval
Copy link
Contributor

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/blog Issues or PRs related to the Kubernetes Blog subproject help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants