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

FAQ #6524

Merged
merged 18 commits into from Apr 13, 2019

Conversation

9 participants
@jolheiser
Copy link
Member

commented Apr 5, 2019

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

jolheiser added some commits Apr 5, 2019

Initial draft
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Update date (not that it's shown...)
Signed-off-by: jolheiser <john.olheiser@gmail.com>

@GiteaBot GiteaBot added the lgtm/need 2 label Apr 5, 2019

Add fail2ban
Signed-off-by: jolheiser <john.olheiser@gmail.com>
@codecov-io

This comment has been minimized.

Copy link

commented Apr 5, 2019

Codecov Report

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

Impacted file tree graph

@@            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 some commits Apr 5, 2019

Added @mrsdizzie suggestions
Added note to support page reminding users to have information available for troubleshooting

Signed-off-by: jolheiser <john.olheiser@gmail.com>
Clarify CustomPath
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Add reminder to try replicating problem on try.gitea.io
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Add more paths
Reminder to make sure Gitea can write to needed directories
Add swagger

Signed-off-by: jolheiser <john.olheiser@gmail.com>
@jolheiser

This comment has been minimized.

Copy link
Member Author

commented Apr 8, 2019

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.

Change to vanity URL
Signed-off-by: jolheiser <john.olheiser@gmail.com>

@jolheiser jolheiser changed the title [WIP] FAQ FAQ Apr 9, 2019

@jolheiser

This comment has been minimized.

Copy link
Member Author

commented Apr 9, 2019

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. 😄

@lunny lunny removed the status/wip label Apr 9, 2019

Crowding -> Crowdin
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Change questions to statements in a few places
Signed-off-by: jolheiser <john.olheiser@gmail.com>

@GiteaBot GiteaBot added lgtm/need 1 and removed lgtm/need 2 labels Apr 10, 2019

@GiteaBot GiteaBot added lgtm/done and removed lgtm/need 1 labels Apr 11, 2019

@zeripath

This comment has been minimized.

Copy link
Contributor

commented Apr 11, 2019

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.

jolheiser added some commits Apr 12, 2019

Add SSH successful error message
Signed-off-by: jolheiser <john.olheiser@gmail.com>

@jolheiser jolheiser force-pushed the jolheiser:6503_faq branch from 7317dcb to d16ae3c Apr 12, 2019

jolheiser added some commits Apr 12, 2019

Remove redundant message
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Add hooks section
Signed-off-by: jolheiser <john.olheiser@gmail.com>

jolheiser and others added some commits Apr 12, 2019

Generify SSH example
Clarify "good" error message

Signed-off-by: jolheiser <john.olheiser@gmail.com>

@techknowlogick techknowlogick merged commit 16fe297 into go-gitea:master Apr 13, 2019

2 checks passed

approvals/lgtm this commit looks good
continuous-integration/drone/pr Build is passing
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.