Skip to content

Add a "Submit Issue" page#139

Open
ebouchut wants to merge 20 commits intonightscout:devfrom
ebouchut:ebouchut/refactor/submit_issue
Open

Add a "Submit Issue" page#139
ebouchut wants to merge 20 commits intonightscout:devfrom
ebouchut:ebouchut/refactor/submit_issue

Conversation

@ebouchut
Copy link
Copy Markdown
Contributor

@ebouchut ebouchut commented May 16, 2025

This PR replaces the link to submit an issue on GitHub with a dedicated page.

The purpose of this page is to encourage users to ask their questions on Facebook and Discord first, and only submit a GitHub issue if the Trio team advises them to do so.

Source
EDIT: Disregard this update, to re-trigger the PR-check that was stuck.

@ebouchut ebouchut added the documentation Improvements or additions to documentation label May 16, 2025
@ebouchut ebouchut force-pushed the ebouchut/refactor/submit_issue branch from 10fef5f to 037f399 Compare May 17, 2025 08:17
Goal: Users should ask for help on FB and Discord first
@ebouchut ebouchut force-pushed the ebouchut/refactor/submit_issue branch from 037f399 to 7f62d1f Compare May 17, 2025 09:10
@ebouchut ebouchut self-assigned this May 18, 2025
@ebouchut ebouchut force-pushed the ebouchut/refactor/submit_issue branch 2 times, most recently from 6f2189f to 04f6fcc Compare May 27, 2025 07:54
Copy link
Copy Markdown
Contributor Author

@ebouchut ebouchut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

@ebouchut ebouchut added the enhancement New feature or request label May 27, 2025
@ebouchut ebouchut marked this pull request as ready for review May 27, 2025 07:55
@ebouchut ebouchut force-pushed the ebouchut/refactor/submit_issue branch from 04f6fcc to e6110d0 Compare May 27, 2025 08:30
@ebouchut
Copy link
Copy Markdown
Contributor Author

@marionbarker would you please take a look and let me know if it meets the initial request.

Copy link
Copy Markdown
Contributor

@marionbarker marionbarker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall Comment

I put in some specific ideas about rearranging particular items.

In addition, I suggest you reorganize to have separate section for Building Help and Using Help.

In the using help - in addition to posting on FB / Discord, they may be asked to post a formal GitHub issue. They need a brief set of instructions on how to do that with a link.

Comment thread docs/help/submit-issue.md Outdated
- [Trio Settings](https://discord.com/channels/1020905149037813862/1239982177190678549)

- [ ] **Avoid posting the same question in multiple groups.**
Many mentors follow several communities, and cross-posting can lead to confusion. Only try another group if you've received no replies after several hours.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would modify the several hours. Perhaps, "Even if you feel your situation cannot wait, give the mentors several hours to respond. Most questions get an answer the same day."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️ Addressed in 436ca41

Comment thread docs/help/submit-issue.md Outdated
Please, do **not** send the same message on multiple sites/channels.
Our volunteers monitor multiple sites.

- [ ] If your **question hasn’t been answered** by checking *TrioDocs* or browsing the *Featured posts* in the Facebook group, go ahead and **post your question**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think lines 32 through 38 belong in the details in How to Ask for Help.

The details currently in How to Ask for Help are specifically about asking for Build Help - and seem to be redundant with some details in What to Share . . .

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️ Addressed in f2df279

Comment thread docs/help/submit-issue.md Outdated

- [ ] Once your **issue is resolved**:
- [ ] **Leave** your **post online** so it can help others
- [ ] **Edit** your **original message** to **include** the word **RESOLVED** at the beginning.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO changing the post online so the original comment with resolved is a Facebook only request.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️ Addressed in 40b4f90

@ebouchut
Copy link
Copy Markdown
Contributor Author

I initially added checkboxes so that users could mark off the steps they'd completed.
However, their state isn't persistent, so refreshing the page resets them to default, which degrades the UX.
I am not sure it's worth keeping them anymore.

@ebouchut ebouchut marked this pull request as draft May 28, 2025 19:46
@ebouchut ebouchut marked this pull request as ready for review December 28, 2025 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants