app
app copied to clipboard
repository-settings
doc more opts
Per @travi request
Resolves #439 Relates https://github.com/probot/settings/issues/220#issuecomment-613741695 Resolves #220 Resolves #420 Resolves #458 Resolves #359 Resolves #402
this documents a bit more than i was expecting from #458. i'm all for documenting each of these, but want to confirm a couple of things before we move forward.
- have all of these properties been confirmed to work through the settings app in addition to the documentation?
- are any of them required? i see that you have mentioned how to disable if they were previously enabled, but if some need to be set to
nullor similar in order to avoid enabling them in the first place due to being required, we should note details like that as well
have all of these properties been confirmed to work through the settings app in addition to the documentation?
yes
are any of them required?
no, otherwise i would have reported an issue :)
i see that you have mentioned how to disable if they were previously enabled, but if some need to be set to null or similar in order to avoid enabling them in the first place due to being required, we should note details like that as well
from many playing around, they are not required and one who does not use these options\keys will have the default github settings of the repository (again, such settings might be inherited from the github organization policy)
Hi @travi, did I answer all of your questions? Is there a need for a further clarification?
Please be patient. This is still on my list. I just haven't gotten back to it yet.
@travi: Shall we give this PR another push for the sake of getting it done before it becomes stale?
@travi
Your work, knowledge sharing and dedication are very appreciated, especially when you do that for free.
If you need a hand in maintaining Probot Setting project, I am offering myself as your apprentice - maybe I could assist you in progressing things you like less or things in a lower priority, so the community could earn back your precious time.
apologies for continued delay here. the last few weeks have been especially busy for me.
i havent been entirely ignoring you, though. the comments that i had above got me thinking further about this project's documentation that i've been considering for a while. basically, i think we need to avoid duplicating documentation that already exists for the api. instead, we should make it more clear that the api documentation is an appropriate reference for the details that can be managed by the settings app. that will help us avoid wording that doesnt quite align with the details outlined by the github technical writing staff, but will also help us avoid the situation where new properties are available from the api that we havent yet added to our examples.
i've started working on some updates to our docs that i think will help make this more clear. examples will still be provided, but it will be more clear that they are not going to include all properties or full descriptions of all that we do include.
that said, i think there are two options for this pr. either we can simplify to the single property that was asked for in #458 so that we can avoid resolving some of the other questions for now, or we can wait until after the restructuring that i'm working on before we decide which additional details would provide value beyond referencing the api documentation.
Thank you @travi for sharing your thoughts. You're the leader, so let's follow whatever you think is best... (I just didn't get what do you prefer from the alternative you shared)
we should make it more clear that the api documentation is an appropriate reference for the details that can be managed by the settings app
I think we have it...
https://github.com/probot/settings/blob/2a2e9333ed68c8dc9962add9d9b9228d7f2c7821/README.md#L19
@travi i think we should try to merge this pull-request since it solves many "issues". do you think we should try to merge or close the pull-request?
@travi would you like to merge these changes or would you like to close the pull-request?
Trying to run this app in enterprise cloud fails by default with the error:
Public repositories are not permitted for Enterprise Managed Organizations.
The setting needed to fix it is not documented, except in this PR. Please for the love of God merge this PR already.
i'm trying to consider what to suggest for this PR after https://github.com/repository-settings/app/pull/893. at minimum, this will need to be adjusted to the updated format of the configuration documentation if we decide to include these updates. however, before investing more effort, lets come to agreement on the below thoughts:
i'm struggling with the value of continuing to add properties to the example. new properties are constantly being added to the api, so being complete in the examples is a losing battle. plus, the examples are meant to be examples with a reference to where to get the complete, official details. i dont intend for the examples to be complete.
i do appreciate the time you've invested in this and i do see value in highlighting certain parts, especially where there might be some confusion that isn't well clarified by the official docs. however, i could use some help deciding what is valuable to include here that isnt just taking the docs closer to completeness rather than examples with official docs references
#893 is a bliss. this pr came after browsing the issues and seeing lots of repeated questions about the configuration (since most don't rtfm), which leads to comments such as https://github.com/repository-settings/app/issues/567#issuecomment-2010700044.
i think we can close this pr. if you think otherwise, please do reopen.