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

Remove app.example.ini #15559

Closed

Conversation

techknowlogick
Copy link
Member

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.

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 techknowlogick added type/docs This PR mainly updates/creates documentation type/refactoring Existing code has been cleaned up. There should be no new functionality. labels Apr 20, 2021
@jolheiser
Copy link
Member

Could you quickly remove the places it's referenced, as well?

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Apr 20, 2021
@techknowlogick
Copy link
Member Author

@jolheiser thanks for that catch. I've updated.

Copy link
Member

@jolheiser jolheiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I realize some will miss the example, however hopefully this can serve as a catalyst to getting the cheat sheet generated from code.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Apr 20, 2021
@silverwind
Copy link
Member

silverwind commented Apr 20, 2021

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

@zeripath
Copy link
Contributor

Another option is just to have the whole damned thing commented out.

@6543
Copy link
Member

6543 commented Apr 21, 2021

I'm for removing, but we have to make sure, to migrate any extra info int the docs from that example ini ...

@yearski
Copy link
Contributor

yearski commented Apr 30, 2021

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

zeripath added a commit to zeripath/gitea that referenced this pull request May 9, 2021
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 <[email protected]>
@techknowlogick techknowlogick deleted the techknowlogick-patch-3 branch May 9, 2021 17:40
6543 pushed a commit that referenced this pull request May 9, 2021
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 <[email protected]>
AbdulrhmnGhanem pushed a commit to kitspace/gitea that referenced this pull request Aug 10, 2021
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 <[email protected]>
@go-gitea go-gitea locked and limited conversation to collaborators Oct 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/need 1 This PR needs approval from one additional maintainer to be merged. type/docs This PR mainly updates/creates documentation type/refactoring Existing code has been cleaned up. There should be no new functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants