Improve FAQ

[brainwane]

• Start to address account recovery policy, FAQ, and tooling #3016 by adding an FAQ item on account recovery.
• Add CoC macros for answers that suggest users file tickets.
• Restructure the "how can I contribute?" answer to include financial donation.
• Fix prose style throughout.

[nlhkabu]

hi @brainwane - I feel like the FAQ is getting pretty long (a good thing!).
Could we maybe add some sub headings in the list at the top to break up the questions into sections?

[brainwane]

Absolutely -- happy to. I was thinking something like <h3>? Do you want me to use any particular id or class?

[nlhkabu]

The sub titles should be <h2>.
We should then change the titles for each question to <h3>

If you can make this change, I can then add a commit to update the styles (I'd like to refactor the .common-question CSS anyway)?

[brainwane]

@nlhkabu Here's an update with subject headings which, of course, looks awful because the CSS hasn't been updated yet. :) Thoughts on the basic structure??

[nlhkabu]

Hi @brainwane - I was thinking that the <h2> would be at the top, e.g.

<h2>Basics</h2>
<ul>
  <li><a href="#packages">{{ packages() }}</a></li>
  <li><a href="#installing">{{ installing() }}</a></li>
  <li><a href="#publishing">{{ publishing() }}</a></li>
  <li><a href="#verified-email">{{ verified_email() }}</a></li>
</ul>

<h2>Integrating</h2>
<ul>
  <li><a href="#APIs">{{ APIs() }}</a></li>
  ...

[brainwane]

Aha, thanks, got it, @nlhkabu - fixed.

[brainwane]

Ready for re-review.

[nlhkabu]

hey @brainwane - I was thinking it could be useful to make the <h2>s links as well?

[brainwane]

@nlhkabu You're right. Fixed and ready for re-review.

[di]

Hmm, something went wrong here. There's a lot of space between the top headings:

And it looks like we lost the little question mark and the spacing around the questions as well.

Before:

After:

[brainwane]

@di Right, that's actually expected right now. @nlhkabu is going to add some CSS changes to make this look right once I have the headers sorted.

[brainwane]

@nlhkabu If you're having trouble pushing to my branch, go ahead and just share the CSS changes with me somehow - a gist, a file emailed to me, something pasted here, a commit to a separate branch of yours, whatever is easiest. And I'll incorporate it so we can get this reviewed and merged.

[nlhkabu]

New styles pushed @brainwane:

One thing I wonder - would "Problems" be better as "Troubleshooting" ?

[brainwane]

Thanks for the styling, @nlhkabu!

I actually like "Problems" for being straightforward and less idiomatic than "Troubleshooting" (for less fluent English speakers). If you have a strong preference, I can bow to it, but I have a preference for "Problems".