opentelemetry-specification icon indicating copy to clipboard operation
opentelemetry-specification copied to clipboard

Transition from .md to .yml for Issue Templates

Open Venkatesh-Krishnan-R opened this issue 1 year ago • 3 comments

What are you trying to achieve? Transitioning our issue templates from Markdown (.md) files to YAML (.yml) files. This shift is intended to improve user interaction and streamline the issue-creation process. The aim is to provide a more intuitive and structured way for users to report bugs, request features, and provide feedback. Advantages:

  1. Enhanced user experience with dropdowns, text areas, and validations.
  2. More structured and consistent issue reporting.
  3. Simplified maintenance and updates to issue templates.

What did you expect to see? screenshot (3) Additional context. Add any other context about the problem here. If you followed an existing documentation, please share the link to it.

I have attached a couple of screenshots showing how the structure looks and how the create issue page appears. I have currently only created it for one specification, and since it is working fine, I can proceed with creating it for the rest of the specifications.

image

Once it is reviewed, I can create a PR for the change

Venkatesh-Krishnan-R avatar Jul 29 '24 05:07 Venkatesh-Krishnan-R

Hi there, I've removed the spec label as this is not specific to the spec itself but rather the repo. I personally like this idea, but will leave it for other community members to give their opinion.

danielgblanco avatar Jul 29 '24 09:07 danielgblanco

I'm glad to receive input from others on how we can streamline it :)

Venkatesh-Krishnan-R avatar Jul 29 '24 09:07 Venkatesh-Krishnan-R

Approved during GC triage. A few SIGs have already made this transition and are happy with it. @Venkatesh-Krishnan-R did you want to take the first crack at this?

mtwo avatar Oct 01 '24 20:10 mtwo