FAQ

[jolheiser]

This is an early draft of the FAQ proposed in #6503

I removed the troubleshooting page and added its contents to this page.

If there is an easier way to generate the top TOC, please let me know. I am not incredibly familiar with what Hugo offers. I found the TOC documentation page, but that seemed to be for an HTML template, not the markdown pages directly.

Please let me know of any additions/changes I can make.

Resolves #6503

[codecov-io]

Codecov Report

Merging #6524 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #6524      +/-   ##
==========================================
- Coverage   40.47%   40.45%   -0.02%     
==========================================
  Files         405      405              
  Lines       54388    54388              
==========================================
- Hits        22013    22004       -9     
- Misses      29348    29358      +10     
+ Partials     3027     3026       -1

Impacted Files	Coverage Δ
models/unit.go	0% <0%> (-14.29%)	⬇️
modules/log/event.go	64.46% <0%> (-1.53%)	⬇️
routers/repo/view.go	41.08% <0%> (-1%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b3e757a...e7ab832. Read the comment docs.

[jolheiser]

Added Swagger explanation (on a few occasions there have been people surprised to find out that Gitea has an API, or are confused by what Swagger is referring to)

@zeripath Also added small blurb about making sure Gitea has write-permission as necessary. Let me know if I covered it well enough.

[jolheiser]

As an initial version, I am going to say this is ready for review.
I anticipate adding more to it in the future, however I don't want to keep this first version in limbo forever while things are slowly added to it either.

Future additions can stay open for longer and slowly add to it, perhaps merging once a month or something.

Feel free to leave it for a bit yet, though, in case there are more things to add. 😄

[zeripath]

Would probably add something about testing your SSH key by trying to login with your key and that you should not get a prompt but rather get the you can't log in message.