product-management
product-management copied to clipboard
Create a Guide/Template: for using <details> and <summary> tags in an issue
Overview
We need to create a guide to using <details> and <summary>
tags so that issues can be more concise.
Action Items
- [x] Update issue #128 with the name of item you are working
- [x] Gather examples of how other projects have done, adding each example as a link in the resources section
- [x] Once done, remove the "TG: Gather Examples" label and add the "TG: Create Guide" label
- [ ] Create a guide on how to use the template
- [ ] Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
- [ ] Review the guide with product management communities of practice
- [ ] Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
- [ ] Present to Hack for LA leadership team for sign off
- [ ] Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
- [ ] Possibly create an issue template on .github
- [ ] Include link to template under resources if you add it as a template in .github
Resources
-
Refer to #123 for how to write a guide and the guide template
-
What is the details html tag:
- https://www.w3schools.com/tags/tag_details.asp
- https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details
Details about how other teams are using it for the Gather step
Example of it in use on an issue: https://github.com/hackforla/website/issues/1146 and these three items are an example of how to use it.
Closed
Open
Example of Code from an issue
Code to try out
<details >
<summary>current gif</summary>

</details>
Drop Down Template Syntax
IMPORTANT: THE EMPTY LINE AFTER THE SUMMARY TAG MUST EXIST FOR formatted content (bullets, images, etc. ) TO RENDER PROPERLY
<details>
<summary>YOUR_TEXT_HERE</summary>
PASTE_YOUR_IMAGE_HERE
</details>
@Sihemgourou are you done working on this?
Hello ! I never started, sorry !