hackforla / knowledgebase-content

GNU General Public License v2.0
0 stars 0 forks source link

Create a Guide/Template: for using <details> and <summary> tags in an issue #22

Open ExperimentsInHonesty opened 3 years ago

ExperimentsInHonesty commented 3 years ago

Overview

We need to create a guide to using <details> and <summary> tags so that issues can be more concise.

Action Items

The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labelled 'Tasks' at the bottom of this issue, and complete each task listed.

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 ![Screen Shot 2021-03-24 at 10 29 58 AM](https://user-images.githubusercontent.com/37763229/112356519-eaa5a880-8c8b-11eb-899a-c00ca74645b3.png)
Open ![image](https://user-images.githubusercontent.com/37763229/112356620-00b36900-8c8c-11eb-8637-37e15ec8e9ff.png)
Example of Code from an issue ![Screen Shot 2021-03-24 at 10 31 35 AM](https://user-images.githubusercontent.com/37763229/112356762-20e32800-8c8c-11eb-91b5-79d59fbf9bf3.png)

Code to try out

<details >
<summary>current gif</summary>

![image](https://www.hackforla.org/assets/images/about/HfLA-Donate.gif)

</details>

Projects to Check

Tasks

akibrhast commented 3 years ago

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>
ExperimentsInHonesty commented 3 years ago

@Sihemgourou are you done working on this?

Sihemgourou commented 3 years ago

Hello ! I never started, sorry !

aymarmsba commented 6 months ago
Prior version of issue

### Overview We need to create a guide to using `

and ` tags so that issues can be more concise. ### Action Items - [x] Update issue hackforla/knowledgebase-content#104 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 hackforla/knowledgebase-content#106 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 ![Screen Shot 2021-03-24 at 10 29 58 AM](https://user-images.githubusercontent.com/37763229/112356519-eaa5a880-8c8b-11eb-899a-c00ca74645b3.png)
Open ![image](https://user-images.githubusercontent.com/37763229/112356620-00b36900-8c8c-11eb-8637-37e15ec8e9ff.png)
Example of Code from an issue ![Screen Shot 2021-03-24 at 10 31 35 AM](https://user-images.githubusercontent.com/37763229/112356762-20e32800-8c8c-11eb-91b5-79d59fbf9bf3.png)
Code to try out ```
current gif ![image](https://www.hackforla.org/assets/images/about/HfLA-Donate.gif)
```

aymarmsba commented 6 months ago
Assignee, Labels, Project Board Placement, and Milestones for this issue in the Product Repo:

![image](https://github.com/hackforla/product-management/assets/155505760/d85150e8-ce56-440d-9e4c-9c194b78a6d7)