Skip to content

Commit 37f9b8c

Browse files
brown9804brown9804
committed
docs formatted
1 parent b418d5f commit 37f9b8c

6 files changed

Lines changed: 99 additions & 57 deletions

File tree

‎.github/pull_request_template.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
## This repository is for GitHub Discussions
1+
# This repository is for GitHub Discussions
22

33
If you intended to start a conversation (question, idea, proposal), please open a Discussion instead:
44

55
- https://github.com/MicrosoftCloudEssentials-LearningHub/org-discussions/discussions
66

7-
If you truly need to change something in this repository (docs/templates), describe the change and why.
7+
If you truly need to change something in this repository (docs/templates), describe the change and why.

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@ See [docs/categories.md](docs/categories.md) for the intended use of each catego
1111
General guidance:
1212

1313
- Use **Q&A** for questions that should end with an accepted answer.
14+
- Use **Support / Troubleshooting** for multi-step debugging or ongoing issues.
1415
- Use **Ideas** for product / process improvement suggestions.
15-
- Use **RFC** for larger proposals that need review.
16-
- Use **Show and tell** to share something you built or learned.
16+
- Use **Show and tell** to share something you built using the materials here (or related content).
17+
- Use **Events** for meetups, livestreams, and community events.
18+
- Use **Polls** to vote on topics and priorities.
19+
20+
Optional (add later):
21+
22+
- Use **RFC** for larger proposals that need review and a clear decision.
1723

1824
## How to write a great discussion
1925

‎README.md‎

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
# org-discussions-public
1+
# Repository that hosts the discussions (Public)
2+
3+
Costa Rica
4+
5+
[![GitHub](https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff)](https://github.com/)
6+
[brown9804](https://github.com/brown9804)
7+
8+
Last updated: 2026-03-04
9+
10+
----------
211

312
This repository is the **home for public GitHub Discussions** for the organization.
413

@@ -10,23 +19,25 @@ Use it to:
1019

1120
## Start here
1221

13-
- **Want to ask a question?** Create a Discussion in **Q&A** and include:
22+
- **Want to ask a question?** Create a Discussion in [Q&A](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/q-a) and include:
1423
- What you expected vs what happened
1524
- Repro steps (or a minimal example)
1625
- Versions / environment details
17-
- **Have an idea?** Post in **Ideas** with the problem, proposed solution, and trade-offs.
18-
- **Need to report a security issue?** Do **not** post it publicly — see [SECURITY.md](SECURITY.md).
26+
- **Have an idea?** Post in [Ideas](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/ideas) with the problem, proposed solution, and trade-offs.
27+
- **Need to report a security issue?** Do **not** post it publicly. Please see [SECURITY.md](SECURITY.md).
1928

20-
## Categories (suggested)
29+
## Categories
2130

22-
Create categories that match how people actually show up. A simple default set:
23-
- **Announcements** (maintainers only)
24-
- **Q&A** (questions with accepted answers)
25-
- **Ideas** (feature requests / improvements)
26-
- **Show and tell** (demos, write-ups, cool things you built)
27-
- **RFC** (bigger proposals that need review)
31+
> The Organization Discussions are organized into a few sections (Community / Product / Support)
2832
29-
More detail (including “what goes where”) lives in [docs/categories.md](docs/categories.md).
33+
The canonical “what goes where” guide lives in [docs/categories.md](docs/categories.md).
34+
35+
Quick pointers:
36+
- [Q&A](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/q-a): clear questions with an accepted answer
37+
- [Support / Troubleshooting](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/support-troubleshooting): longer debugging threads
38+
- [Ideas](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/ideas): proposals and improvements
39+
- [Show and tell](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/show-and-tell): what you built (demos/integrations)
40+
- [Events](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/events): meetups/livestreams/webinars
3041

3142
## How we keep discussions useful
3243

@@ -35,8 +46,14 @@ More detail (including “what goes where”) lives in [docs/categories.md](docs
3546
- **Use clear titles** (good: “CLI auth fails with 401 on Windows”, bad: “Help!!!”)
3647
- **Close the loop** when solved (summarize the fix and mark the answer if applicable)
3748

38-
## Community & conduct
39-
40-
By participating, you agree to follow our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
41-
42-
If you’re not sure where to ask something, see [SUPPORT.md](SUPPORT.md).
49+
> [!IMPORTANT]
50+
> Community & Conduct:
51+
> - By participating, you agree to follow our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
52+
> - If you’re not sure where to ask something, see [SUPPORT.md](SUPPORT.md).
53+
54+
<!-- START BADGE -->
55+
<div align="center">
56+
<img src="https://img.shields.io/badge/Total%20views-1337-limegreen" alt="Total views">
57+
<p>Refresh Date: 2026-03-04</p>
58+
</div>
59+
<!-- END BADGE -->

‎docs/categories.md‎

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,26 @@
11
# Discussion categories
22

3-
This page describes a suggested category setup for an organization Discussions hub.
3+
Costa Rica
44

5-
## Announcements
5+
[![GitHub](https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff)](https://github.com/)
6+
[brown9804](https://github.com/brown9804)
67

7-
- **Purpose**: official updates from maintainers
8-
- **Examples**: releases, policy changes, scheduled maintenance, roadmap milestones
9-
- **Posting**: keep this restricted (maintainers/moderators)
8+
Last updated: 2026-03-04
109

11-
## Q&A
10+
----------
1211

13-
- **Purpose**: questions with a concrete answer
14-
- **Best practices**: mark accepted answers; summarize the resolution at the end
12+
> This page describes the category setup for this organization’s GitHub Discussions hub.
1513
16-
## Ideas
14+
| Section | Categories (type) | When to use it | Examples / best practices |
15+
|---|---|---|---|
16+
| Community | - **General** (Discussion)<br>- **Show and tell** (Discussion)<br>- **Polls** (Poll)<br>- **Events** (Discussion) | - **General**: anything community/meta that doesn’t fit elsewhere<br>- **Show and tell**: demos, write-ups, integrations, things you built<br>- **Polls**: quick votes to guide priorities (“next livestream topic?”, “next feature?”)<br>- **Events**: meetups/livestreams/webinars and follow-ups | - **General** titles: “How should we organize learning paths?”, “Introduce yourself + what you’re building”<br>- **Show and tell**: include a link/screenshot + short “how it works” + what you used from the provided materials<br>- **Polls**: keep options mutually exclusive (3–6), set a close date, and comment with the decision afterward<br>- **Events**: include date/time + timezone, agenda/link, and ask for RSVP via 👍 or a comment |
17+
| Product | - **Announcements** (Announcement)<br>- **Ideas** (Discussion) | - **Announcements**: official updates from maintainers (releases, policy changes, roadmap milestones)<br>- **Ideas**: suggestions and improvement proposals | - **Announcements**: start with a 2–3 line TL;DR; link to docs/issues; pin major updates if needed<br>- **Ideas**: use a simple structure (problem → proposal → trade-offs); include success criteria so others can evaluate it |
18+
| Support | - **Q&A** (Q&A)<br>- **Support / Troubleshooting** (Q&A) | - **Q&A**: questions that should end with a clear accepted answer (how-to, “what’s the right way?”)<br>- **Support / Troubleshooting**: longer back-and-forth debugging threads and ongoing issues | - **Q&A**: ask one clear question, share what you tried, and mark an accepted answer when solved (plus a short resolution summary)<br>- **Troubleshooting**: include expected vs actual, repro steps, environment/versions, and logs (redact secrets); summarize the root cause/fix at the end |
1719

18-
- **Purpose**: suggestions, feature requests, process improvements
19-
- **Template**: problem → proposal → alternatives → trade-offs → success criteria
2020

21-
## Show and tell
22-
23-
- **Purpose**: share demos, write-ups, integrations, or lessons learned
24-
- **Note**: link to source or screenshots when possible
25-
26-
## RFC
27-
28-
- **Purpose**: bigger changes needing review and decision
29-
- **Template**: context → goals/non-goals → proposal → risks → rollout plan
30-
31-
## Optional categories
32-
33-
Add these only if you see sustained demand:
34-
35-
- **Support / Troubleshooting** (if Q&A becomes too broad)
36-
- **Jobs** (if the community expects it)
37-
- **Events** (meetups, livestreams)
38-
- **Off topic** (only if you can moderate it)
21+
<!-- START BADGE -->
22+
<div align="center">
23+
<img src="https://img.shields.io/badge/Total%20views-1337-limegreen" alt="Total views">
24+
<p>Refresh Date: 2026-03-04</p>
25+
</div>
26+
<!-- END BADGE -->

‎docs/moderation.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# Moderation guide
22

3-
This is a lightweight playbook for keeping Discussions welcoming and high-signal.
3+
Costa Rica
4+
5+
[![GitHub](https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff)](https://github.com/)
6+
[brown9804](https://github.com/brown9804)
7+
8+
Last updated: 2026-03-04
9+
10+
----------
11+
12+
> This is a lightweight playbook for keeping Discussions welcoming and high-signal.
413
514
## When to intervene
615

@@ -27,3 +36,10 @@ This is a lightweight playbook for keeping Discussions welcoming and high-signal
2736

2837
- For security, redirect to [SECURITY.md](../SECURITY.md)
2938
- For conduct, redirect to [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)
39+
40+
<!-- START BADGE -->
41+
<div align="center">
42+
<img src="https://img.shields.io/badge/Total%20views-1337-limegreen" alt="Total views">
43+
<p>Refresh Date: 2026-03-04</p>
44+
</div>
45+
<!-- END BADGE -->

‎docs/welcome-draft.md‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
11
# Welcome to the organization Discussions
22

3-
If you’re new here, start with the **Q&A** category for questions or **Ideas** for proposals.
3+
Costa Rica
44

5-
A few tips:
5+
[![GitHub](https://img.shields.io/badge/--181717?logo=github&logoColor=ffffff)](https://github.com/)
6+
[brown9804](https://github.com/brown9804)
67

7-
- Search before posting
8-
- Include enough context for others to reproduce/understand
9-
- Be kind; assume positive intent
8+
Last updated: 2026-03-04
109

11-
See the repository README for the full guide.
10+
----------
11+
12+
- If you’re new here, start with [Q&A](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/q-a) for questions or [Ideas](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/ideas) for proposals.
13+
- If you’re debugging an issue that needs back-and-forth, use [Support / Troubleshooting](https://github.com/orgs/MicrosoftCloudEssentials-LearningHub/discussions/categories/support-troubleshooting).
14+
15+
> [!TIP]
16+
> - Search before posting
17+
> - Include enough context for others to reproduce/understand
18+
> - Be kind; assume positive intent
19+
20+
See [docs/categories.md](categories.md) for what goes where.
21+
<!-- START BADGE -->
22+
<div align="center">
23+
<img src="https://img.shields.io/badge/Total%20views-1337-limegreen" alt="Total views">
24+
<p>Refresh Date: 2026-03-04</p>
25+
</div>
26+
<!-- END BADGE -->

0 commit comments

Comments
 (0)