Skip to content

Commit 4dd2154

Browse files
authored
Merge branch 'main' into ctrehan/246
2 parents 94785e3 + 2818a6c commit 4dd2154

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+5600
-184
lines changed

.all-contributorsrc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,27 @@
369369
"name": "Daniel S. Katz",
370370
"avatar_url": "https://avatars.githubusercontent.com/u/2913845?v=4",
371371
"profile": "https://danielskatz.org",
372+
"contributions": [
373+
"code",
374+
"maintenance"
375+
]
376+
},
377+
{
378+
"login": "rivaquiroga",
379+
"name": "Riva Quiroga",
380+
"avatar_url": "https://avatars.githubusercontent.com/u/31421616?v=4",
381+
"profile": "https://rivaquiroga.cl/",
382+
"contributions": [
383+
"ideas",
384+
"code",
385+
"maintenance"
386+
]
387+
},
388+
{
389+
"login": "karanveerksb",
390+
"name": "Karanveer Singh",
391+
"avatar_url": "https://avatars.githubusercontent.com/u/143838558?v=4",
392+
"profile": "https://github.com/karanveerksb",
372393
"contributions": [
373394
"code"
374395
]
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug to help us improve the DISCOVER Cookbook
3+
title: "[Bug]: "
4+
labels: ["🐛 bug", "🧰 maintenance"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Thank you for taking the time to fill out this bug report!**
12+
To help us resolve this issue as quickly as possible, please provide as much detail as you can.
13+
14+
Before opening a new issue, please:
15+
1. **Search [existing issues](https://github.com/numfocus/DISCOVER-Cookbook/issues)**: Check if your bug has already been reported.
16+
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.
17+
18+
19+
- type: textarea
20+
id: bug-description
21+
attributes:
22+
label: Describe the Bug
23+
description: "A clear and concise description of what the bug is. What did you see? What did you expect to see?"
24+
placeholder: "e.g., The DISC logo is missing from the header of the 'Tags Overview' page, making it inconsistent with other pages."
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: steps-to-reproduce
30+
attributes:
31+
label: Steps to Reproduce
32+
description: "Please provide detailed steps to reproduce the behavior."
33+
placeholder: |
34+
1. Go to the DISCOVER Cookbook.
35+
2. Click on 'Tags overview' in the navigation menu.
36+
3. Observe the header section.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: expected-behavior
42+
attributes:
43+
label: Expected Behavior
44+
description: "A clear and concise description of what you expected to happen."
45+
placeholder: "I expected to see the DISC logo displayed in the header of the 'Tags Overview' page."
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: screenshots
51+
attributes:
52+
label: Screenshots or Screencasts
53+
description: "If applicable, add screenshots or a short video to help explain your problem."
54+
placeholder: "You can drag and drop images or GIFs here."
55+
56+
- type: textarea
57+
id: additional-context
58+
attributes:
59+
label: Additional Context
60+
description: "Is there anything else you'd like to add? For example, have you tried to fix this yourself? Do you have suggestions for a solution?"
61+
62+
- type: checkboxes
63+
id: contribution
64+
attributes:
65+
label: Contribution
66+
options:
67+
- 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).
68+
required: true
69+
- label: I would like to submit a pull request to fix this bug.
70+
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: ✨ Content Enhancement
2+
description: Propose improvements, updates, new measures, or clarifications for the DISCOVER Cookbook.
3+
title: "[Enhancement]: "
4+
labels: ["✨ content enhancement"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Thank you for contributing to the DISCOVER Cookbook!** Your suggestions help us keep our content accurate, actionable, and inclusive.
12+
13+
Before opening a new issue, please:
14+
1. **Search [existing issues](https://github.com/numfocus/DISCOVER-Cookbook/issues)**: Check if your suggestion has already been discussed or is in progress.
15+
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.
16+
17+
- type: dropdown
18+
id: enhancement-type
19+
attributes:
20+
label: Type of Enhancement
21+
description: What kind of content improvement are you proposing?
22+
options:
23+
- "Clarification/Rewording (e.g., making text clearer, simplifying language)"
24+
- "Adding a new specific example to an existing measure"
25+
- "Updating outdated information (e.g., broken links, contact details)"
26+
- "Proposing a minor new measure (🍎 or ✅) within an existing section"
27+
- "Adding/improving 'Further Reading' resources"
28+
- "Structural suggestion (e.g., reordering content within a page)"
29+
- "Other (please describe below)"
30+
validations:
31+
required: true
32+
33+
- type: input
34+
id: relevant-page-url
35+
attributes:
36+
label: Relevant Page(s) URL (if applicable)
37+
description: Please provide the full URL(s) to the page(s) where the enhancement is proposed.
38+
placeholder: "e.g., https://discover-cookbook.numfocus.org/04_venue_selection.html"
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: current-content-snippet
44+
attributes:
45+
label: Current Content Snippet (Optional, but helpful)
46+
description: Copy and paste the specific text or a brief snippet of the section you want to enhance.
47+
placeholder: "e.g., 'Consider attendees who may need accommodations for a disability'"
48+
49+
- type: textarea
50+
id: proposed-enhancement
51+
attributes:
52+
label: Proposed Enhancement / Suggestion
53+
description: Describe your suggested improvement in detail. Be specific about new wording, examples, additions, or structural changes.
54+
placeholder: |
55+
e.g.,
56+
For the 'Accessibility Considerations' subsection under 'Venue Selection & On-Site Services', I propose adding a new point:
57+
58+
### Create Access Visual & Hearing Disabilities
59+
- ✅ Select a venue that has a hearing loop, or audio induction loop (a special type of sound system for use by people with hearing aids) and make sure it is used.
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: rationale-and-impact
65+
attributes:
66+
label: Rationale & Expected Impact
67+
description: Explain *why* this enhancement is valuable. How does it improve clarity, actionability, inclusivity, or impact for conference organizers or attendees? How does it align with the 🍎 (easy, high impact) or ✅ (more effort, considerable impact) framework?
68+
placeholder: "e.g., Adding a guideline about hearing loops significantly enhances accessibility for deaf and hard-of-hearing attendees, making the conference more inclusive. This is a ✅ measure as it requires specific venue selection or setup but has a considerable positive impact."
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: additional-resources
74+
attributes:
75+
label: Additional Resources / Further Reading
76+
description: Provide links to external resources, research, or examples that support your suggestion.
77+
placeholder: "e.g., [https://www.hearinglink.org/technology/hearing-loops/what-is-a-hearing-loop/](https://www.hearinglink.org/technology/hearing-loops/what-is-a-hearing-loop/)"
78+
validations:
79+
required: true
80+
81+
- type: checkboxes
82+
id: willingness-to-contribute
83+
attributes:
84+
label: Contribution
85+
options:
86+
- 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).
87+
required: true
88+
- label: I would be willing to draft a pull request to implement this enhancement.
89+
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
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+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Description of Changes
2+
3+
<!-- Clearly and concisely describe the changes introduced by this Pull Request.
4+
What problem does it solve? What new content or improvements does it bring? -->
5+
6+
7+
## Related Issue
8+
9+
<!-- Link this Pull Request to the relevant GitHub Issue.
10+
Use keywords like `Closes #<issue-number>`, `Fixes #<issue-number>`, or `Resolves #<issue-number>`
11+
to automatically close the issue when the PR is merged.
12+
[Learn more](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). -->
13+
14+
15+
## Type of Change
16+
17+
Please check the appropriate box that describes your PR:
18+
19+
- [ ] 🐛 Bug Fix — Fixes a documented issue or incorrect behavior
20+
- [ ] ✨ Content Enhancement — Updates or improves existing content
21+
- [ ] ✍️ New Content — Adds new chapters, examples, or significant sections
22+
- [ ] 🛠️ Other — Please describe in the *Description of Changes* section
23+
24+
25+
## Additional Notes (Optional)
26+
27+
<!-- Add any other relevant context or information about the changes here.
28+
Include screenshots or references if helpful. -->
29+
30+
31+
## Checklist
32+
33+
- [ ] I have searched [open pull requests](https://github.com/numfocus/DISCOVER-Cookbook/pulls) to avoid duplicates.
34+
- [ ] I have built the book locally using the [build instructions](https://github.com/numfocus/DISCOVER-Cookbook#how-to-run-the-book-locally) and verified my changes work as expected.
35+
- [ ] I have written clear, conventional commit messages, as per the [Pull Request Guidelines](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md#pull-request-guidelines).

.github/workflows/build-gh-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Build the book
2727
run: |
2828
rm -rf DISCOVER/_tags/*
29-
jupyter-book build DISCOVER
29+
sphinx-build -b html DISCOVER/ DISCOVER/_build/html
3030
3131
- name: Push book HTML to gh-pages
3232
uses: peaceiris/[email protected]

0 commit comments

Comments
 (0)