Remove app.example.ini #15559
Remove app.example.ini #15559
Conversation
Users aren't reading the disclaimer at the beginning of this file which is more harmful than helpful. A future PR could be to generate the docs.gitea.io page from go structs, but this is a starting point.
techknowlogick
added
type/docs
|
Could you quickly remove the places it's referenced, as well? |
GiteaBot
added
the
lgtm/need 2
|
@jolheiser thanks for that catch. I've updated. |
GiteaBot
added
lgtm/need 1
|
I think there are dozens of options that are only documented in that file. I'm happy to have one documentation source in the future but care should be taken that no documentation is lost. Please compare and add missing options to the cheat sheet (I don't really like that name). |
|
Another option is just to have the whole damned thing commented out. |
|
I'm for removing, but we have to make sure, to migrate any extra info int the docs from that example ini ... |
|
As a regular user, I depend on the config file being provided. Whenever I upgrade, I diff the new example against my current file to find new and deleted options. The Gitea config is pretty overwhelming but it's still the best chance I have of keeping up. I won't digest all of the release notes with the same scrutiny. There's a bit of momentum here already but if there was a chance to reconsider... |
This PR is an alternative to go-gitea#15559. Instead of deleting the app.example.ini - just comment out most of the thing. This makes it clear what needs to be set and what is completely optional - and keeps the documentation. The app.example.ini is moved around to move the most important settings higher in the document. Close go-gitea#15559 Signed-off-by: Andrew Thornton <art27@cantab.net>
This PR is an alternative to #15559. Instead of deleting the app.example.ini - just comment out most of the thing. This makes it clear what needs to be set and what is completely optional - and keeps the documentation. The app.example.ini is moved around to move the most important settings higher in the document. Close #15559 Signed-off-by: Andrew Thornton <art27@cantab.net>
This PR is an alternative to go-gitea#15559. Instead of deleting the app.example.ini - just comment out most of the thing. This makes it clear what needs to be set and what is completely optional - and keeps the documentation. The app.example.ini is moved around to move the most important settings higher in the document. Close go-gitea#15559 Signed-off-by: Andrew Thornton <art27@cantab.net>
Users aren't reading the disclaimer at the beginning of this file which is more harmful than helpful.
A future PR could be to generate the docs.gitea.io page from go structs, but this is a starting point.