|
| 1 | +name: 📖 New Chapter Proposal |
| 2 | +description: Propose a new chapter or significant content addition for the DISCOVER Cookbook. |
| 3 | +title: "[New Chapter Proposal]: " |
| 4 | +labels: ["✍️ new content" , "📖 new chapter"] |
| 5 | +assignees: [] |
| 6 | + |
| 7 | +body: |
| 8 | + - type: markdown |
| 9 | + attributes: |
| 10 | + value: | |
| 11 | + **Thank you for your interest in contributing to the DISCOVER Cookbook!** |
| 12 | +
|
| 13 | + Please use this template to propose a new chapter or a substantial content addition. Providing thorough details will help us understand your idea and facilitate a quicker review process. |
| 14 | +
|
| 15 | + Before opening a new issue, please: |
| 16 | + 1. **Search [existing issues](https://github.com/numfocus/DISCOVER-Cookbook/issues)**: Check if your suggestion has already been discussed or is in progress. |
| 17 | + 2. **Review our contribution guidelines**: Please read our **[CONTRIBUTING.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md)** before contributing. |
| 18 | +
|
| 19 | +
|
| 20 | + - type: textarea |
| 21 | + id: problem-statement |
| 22 | + attributes: |
| 23 | + label: 1. Problem/Gap Addressed |
| 24 | + description: "What problem does this new chapter solve, or what gap in the existing DISCOVER Cookbook content does it fill? Why is this chapter needed now?" |
| 25 | + placeholder: "e.g., The Cookbook lacks comprehensive guidance on managing accessibility for virtual attendees, which is increasingly relevant for hybrid events." |
| 26 | + validations: |
| 27 | + required: true |
| 28 | + |
| 29 | + - type: textarea |
| 30 | + id: proposed-solution |
| 31 | + attributes: |
| 32 | + label: 2. Proposed Chapter Title & Brief Description |
| 33 | + description: "What is your proposed title for the new chapter? Provide a concise summary of its content and main objectives." |
| 34 | + placeholder: "e.g., Title: 'Virtual & Hybrid Event Accessibility'. Description: This chapter will provide practical guidelines for ensuring virtual and hybrid events are accessible to all participants, covering digital tools, captioning, and time zone considerations." |
| 35 | + validations: |
| 36 | + required: true |
| 37 | + |
| 38 | + - type: dropdown |
| 39 | + id: chapter-type |
| 40 | + attributes: |
| 41 | + label: 3. Chapter Type (Diátaxis Framework) |
| 42 | + description: "Following the Diátaxis framework, what type of documentation will this chapter primarily be? (Select the best fit. See(https://diataxis.fr/) for definitions.)" |
| 43 | + options: |
| 44 | + - "Tutorial (Learning-oriented, guides through a process step-by-step)" |
| 45 | + - "How-to Guide (Goal-oriented, steps for a specific task)" |
| 46 | + - "Explanation (Understanding-oriented, discusses concepts and principles)" |
| 47 | + - "Reference (Information-oriented, technical specifications or detailed facts)" |
| 48 | + default: 1 # Default How-to Guide |
| 49 | + validations: |
| 50 | + required: true |
| 51 | + |
| 52 | + - type: textarea |
| 53 | + id: target-audience |
| 54 | + attributes: |
| 55 | + label: 4. Target Audience |
| 56 | + description: "Who is the primary audience for this chapter? (e.g., Event organizers, tech support teams, speakers, virtual attendees)" |
| 57 | + placeholder: "e.g., Event organizers, AV teams, and platform administrators planning virtual or hybrid components." |
| 58 | + validations: |
| 59 | + required: true |
| 60 | + |
| 61 | + - type: textarea |
| 62 | + id: key-topics |
| 63 | + attributes: |
| 64 | + label: 5. Key Topics & Outline |
| 65 | + description: "List the main sections and key topics you plan to cover in this chapter. Provide a brief outline or bullet points. If proposing new 🍎 (easy, high impact) or ✅ (more effort, considerable impact) measures, indicate them here." |
| 66 | + placeholder: | |
| 67 | + - Introduction to virtual accessibility principles |
| 68 | + - Digital platform accessibility (WCAG compliance, screen reader compatibility) |
| 69 | + - Live captioning and sign language interpretation for virtual sessions (✅) |
| 70 | + - Time zone considerations for global participation (🍎) |
| 71 | + - Accessible presentation materials (slides, documents) |
| 72 | + - Post-event accessibility (recordings, transcripts) |
| 73 | + validations: |
| 74 | + required: true |
| 75 | + |
| 76 | + - type: textarea |
| 77 | + id: existing-content-integration |
| 78 | + attributes: |
| 79 | + label: 6. Integration with Existing Cookbook Content |
| 80 | + description: "How does this proposed chapter relate to or integrate with existing sections of the DISCOVER Cookbook? Are there any existing chapters it would link to, expand upon, or replace?" |
| 81 | + placeholder: "e.g., This chapter would complement 'Venue Selection & On-Site Services' by extending accessibility to virtual spaces. It could link to 'Participant and Speaker Selection' for inclusive speaker guidelines in a virtual context." |
| 82 | + validations: |
| 83 | + required: true |
| 84 | + |
| 85 | + - type: textarea |
| 86 | + id: value-proposition |
| 87 | + attributes: |
| 88 | + label: 7. Value Proposition / Expected Impact |
| 89 | + description: "What value will this chapter bring to the DISCOVER Cookbook and its users? How will its success be measured?" |
| 90 | + placeholder: "e.g., It will make the Cookbook relevant for modern event formats, significantly increasing accessibility for remote participants and broadening the Cookbook's reach and impact." |
| 91 | + validations: |
| 92 | + required: true |
| 93 | + |
| 94 | + - type: textarea |
| 95 | + id: suggested-tags |
| 96 | + attributes: |
| 97 | + label: 8. Suggested Tags (from `_tags/` directory) |
| 98 | + description: "Based on the existing `_tags/` directory (e.g., `_tags/mobility-impairment.md`), which tags would be most relevant for this new content?" |
| 99 | + placeholder: "e.g., Digital-Accessibility, Virtual-Events, Hearing-Impairment, Visual-Impairment, Global-South" |
| 100 | + |
| 101 | + - type: textarea |
| 102 | + id: additional-resources |
| 103 | + attributes: |
| 104 | + label: 9. Additional Resources / Further Reading |
| 105 | + description: "Provide links to external resources, research, or examples that could be referenced in this new content." |
| 106 | + placeholder: | |
| 107 | + - W3C Web Content Accessibility Guidelines (WCAG): Core guidelines for digital accessibility. [https://www.w3.org/WAI/WCAG21/quickref/](https://www.w3.org/WAI/WCAG21/quickref/) |
| 108 | + - Zoom Accessibility Features: Official guide to accessibility options within Zoom. [https://explore.zoom.us/docs/en-us/accessibility.html](https://explore.zoom.us/docs/en-us/accessibility.html) |
| 109 | +
|
| 110 | + - type: checkboxes |
| 111 | + id: contribution |
| 112 | + attributes: |
| 113 | + label: Contribution |
| 114 | + description: "By submitting this proposal, you agree to the following:" |
| 115 | + options: |
| 116 | + - label: I am willing to collaborate with maintainers and other contributors on this chapter. |
| 117 | + required: true |
| 118 | + - label: I agree to follow the DISCOVER Cookbook's [Code of Conduct](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md). |
| 119 | + required: true |
| 120 | + - label: I would be willing to draft a pull request to implement this enhancement. |
| 121 | + |
0 commit comments