Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create "Help" page for website #6963

Open
ninavizz opened this issue Oct 12, 2021 · 3 comments
Open

Create "Help" page for website #6963

ninavizz opened this issue Oct 12, 2021 · 3 comments
Labels
C: website help wanted This issue will probably not get done in a timely fashion without help from community contributors. P: default Priority: default. Default priority for new issues, to be replaced given sufficient information. T: enhancement Type: enhancement. A new feature that does not yet exist or improvement of existing functionality. ux User experience

Comments

@ninavizz
Copy link
Member

ninavizz commented Oct 12, 2021

How to file a helpful issue

The problem you're addressing (if any)

Per #6835, a new page from the website that lives outside of the docs, has been decided to be a need.

The solution you'd like

  1. Create new webpage, with the design + content from this Figma page.
  • Will likely require a little more webdev-fu than any of the core team are able to provide.
    • Are you that awesome person? Hooray!
      • In the upper-right on the Figma window, you should see an "Inspect" panel. That is where you can see dimensions and sizing and hex values and such.
      • All typography done with Roboto Condensed instead of Ostrich, assuming that CSS will eventually change. No intentions to have this page in Roboto Condensed, and the rest of the site Ostrich (so, code to global styles—and if/when those change, great!).
      • Accordion mid-page presumed to be either OEM styled or customized Bootstrap 5 widget. Would be preferred to style with "Hide All" and "Show All" option, for viewing in Tor w/o JS.
      • Accordion content is redundant with (and edited a tad) content in docs, which should be edited and instead point to the webpage, once it goes live.
  • H1 icon should be done as an image, and not font-awesome, per item 12 on this punchlist.
  1. Remove redundant content from docs help/support page.
  2. Replace the current "Documentation" button on the main navigation, with a link to this new page.
  3. Ignore footer—will address in separate issue (unless whomever takes this on wishes to be an ultra-mesch and do that, too).

Mockup:
Support-alt

The value to a user, and who that user might be

  • End Users
    • Folks using Qubes and unaccustomed to looking for crtical information in developer docs.
    • Folks using the Docs but unable to find paths to forum, email list, etc.
    • Many survey comments speak to "poor customer service" or inability to find support. Spelling it out in a more consumer-centric fashion on the website, seems likely to solve for this as much as can be solved-for, short of creating said department that nobody on the core team probably wants, even if the money existed.
  • Core Team
    • Folks currently email us from the Team page, when they can't find stuff they need. This is a distraction and kind of a drag that may likely be easy to resolve or cut-down on, with more discoverable help content.
    • A parallel recommendation is creating a Contact Us page for general contact info to live on, and demote the "Team" page to the footer.
@ninavizz ninavizz added T: enhancement Type: enhancement. A new feature that does not yet exist or improvement of existing functionality. help wanted This issue will probably not get done in a timely fashion without help from community contributors. C: website P: default Priority: default. Default priority for new issues, to be replaced given sufficient information. labels Oct 12, 2021
@ninavizz
Copy link
Member Author

Accordion content (below) will become redundant with Docs, and should likely be removed from the docs to prevent redundancy once page goes live. Links & destinations are all in docs:

Accordion 1

A1-Q: How can I get to the bottom of a problem I’m having?
A1-A: 1. Check the documentation. There may already be a page about it. Specifically, check out the How-To Guides and Troubleshooting sections.

2. Search the FAQ. Your question might already be answered.

3. Try searching the issue tracker. There may already be an open or closed issue about your problem. The issue tracker is constantly being updated 
 with known bugs and may contain workarounds for problems you’re experiencing. If there any pinned issues at the top, make sure to check them first!

4. Try searching the Qubes Forum. There may already be a matching topic.

5. Try searching the qubes-users archives. There may have already been a relevant thread.

Accordion 2

A2-Q: I didn’t find a solution or an answer
A2-A: Sorry to hear that! We recommend asking for help on the Qubes Forum or on the qubes-users mailing list. If you’re shy, please know our community is international, includes folks of all abilities, and that our moderators strictly enforce our Code of Conduct. Choose the venue you prefer, but please don’t ask on both at the same time. Before you ask, please review our discussion guidelines and Code of Conduct. We have a zero tollerance policy for bullies.

We also recommend StackOverflow’s advice on how to ask good questions. Don’t forget to stay safe!

Accordion 3

A3-Q: I don’t need support, but I think I found a bug or a security vulnerability
A3-A: We’d be grateful if you’d report it! If it’s a bug, we only ask that you do a quick check to make sure no one else has already reported it, first. 
Please see Issue Tracking for details. For security concerns, please see Reporting Security Issues in Qubes OS. Thank you!!

Accordion 4

A4-Q: How can I request a feature?
A4-A: No promises, but we’d be happy to consider it! Please see Issue Tracking for details.

Accordion 5

A5-Q: I’m trying to find your customer service—I just really want to speak to a representative
A5-A: We understand feeling frustrated. We really do! We take a lot of pride in our user community—most of whom are volunteers. Qubes OS is a free and open-source project, and operates on a shoestring budget. Qubes is also a complicated and evolving product that even our core contributors look to our community for support with.

While a community model may be a different kind of support than many are used to, we do strictly enforce a code of conduct to keep things respectful and inclusive, while encouraging discussion guidelines to keep things productive.

Learning and sharing are the priorities we encourage in our community, not showboating or grandstanding. Please do give it a try!

@ninavizz
Copy link
Member Author

PNG files, below

Created at 300% what their 100% size will be. Should be implemented at 30% to factor for image degradation with pixel-dense or zoomed-in layouts.

ITLSupport
icon-community

@ninavizz ninavizz changed the title Create "Get Support" page for website Create "Help" page for website Oct 12, 2021
@andrewdavidwong andrewdavidwong added this to the Non-release milestone Oct 13, 2021
@deeplow
Copy link

deeplow commented Feb 2, 2022

Feedback
The help page looks perfect to me.

  • The order "Documentation -> Community" is very nice.
  • The "paths for solving problems" is something I've never seen, but next level genius :)

Suggestions:

  • "Community" -> "Community Support"
  • "Qubes Forum - hosted by discourse" is no longer true. It's hosted by communiteq, but I don't think the hosting is relevant here.

@andrewdavidwong andrewdavidwong added the ux User experience label Feb 2, 2022
@andrewdavidwong andrewdavidwong removed this from the Non-release milestone Aug 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: website help wanted This issue will probably not get done in a timely fashion without help from community contributors. P: default Priority: default. Default priority for new issues, to be replaced given sufficient information. T: enhancement Type: enhancement. A new feature that does not yet exist or improvement of existing functionality. ux User experience
Projects
None yet
Development

No branches or pull requests

3 participants