Skip to content

Conversation

@FloorD
Copy link
Contributor

@FloorD FloorD commented Nov 3, 2025

Creates Issue Template to avoid issues or requests related to the CloudNativePG Docs.

Closes #373

Creates Issue Template to avoid issues or requests related to the CloudNativePG Docs. Based on issue #373
@FloorD FloorD requested a review from a team as a code owner November 3, 2025 14:59
@sxd
Copy link
Member

sxd commented Nov 4, 2025

@jsilvela What do you think about this?
@FloorD the DCO is failing

@jsilvela
Copy link
Contributor

jsilvela commented Nov 4, 2025

Asking out of unfamiliarity here: looking at the operator repo, the issue templates are configured with YAML, not markdown. And in the GH docs, I see only YAML examples, though they mention markdown.
If they do accept markdown, does it support Hugo style front matter?

Copy link
Contributor

@jsilvela jsilvela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we configure issue templates with markdown and a Hugo-style front matter?

Co-authored-by: Jaime Silvela <jaime.silvela@enterprisedb.com>
Signed-off-by: Floor Drees <floordrees@gmail.com>
@sxd
Copy link
Member

sxd commented Nov 6, 2025

Can we configure issue templates with markdown and a Hugo-style front matter?

What do you mean by "with markdown and a Hugo-style" ? I didn't got anything from the phrase :D

@jsilvela
Copy link
Contributor

jsilvela commented Nov 6, 2025

What I mean:
These lines at the top of the file issue-template.md are not proper markdown.

---
name: Issue template
about: 'Issue template for cloudnative-pg.io '
...
...

This is a custom format in Hugo to add metadata to blog posts. In hugo that section is called the front matter. See https://gohugo.io/content-management/front-matter/

So my question is: is this a format that will work in GitHub? To be honest I'd be surprised, but I have not set up issue templates, so I may be wrong.

@jsilvela
Copy link
Contributor

jsilvela commented Nov 6, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configure Issue Templates to prevent the opening of documentation Issues in this repo

3 participants