-
Notifications
You must be signed in to change notification settings - Fork 33
Documentation around organization settings is inconsistent #263
Comments
This makes sense and is fairly straight forward. Would you like to open a pull request to fix this @JoshuaTheMiller? |
@zkoppert, if no one beats me to it, yes 🙂 |
This issue has been automatically marked as stale because it has not had recent activity. If you think this issue should stay open, please remove the |
(I really do plan on getting to this) |
This issue has been automatically marked as stale because it has not had recent activity. If you think this issue should stay open, please remove the |
Finally getting to this.... 😅 |
* Associated with github#263
Describe the bug
Documentation around organization settings is inconsistent. The README states that to configure this Probot for an entire GitHub Organization, one should create a repository named
rally-github-config
(unless theORG_CONFIG_REPO_NAME
environment variable is set to something else). Elsewhere, documentation states that the default value ofORG_CONFIG_REPO_NAME
is actually.github
.A quick search through the codebase shows that the default value for
ORG_CONFIG_REPO_NAME
is actually.github
.The proposed solution is to update the documentation to reflect the correct default value. Why? To mitigate mistakes cause by quickly glancing through the REAMDE 🙂
Version
v1.2.0
To Reproduce
Steps to reproduce the behavior:
Expected behavior
For the README to be consistent.
Screenshots
Additional context
This seemed to be the most valid Issue template. Hopefully considering this to be a "documentation bug" is not too far of a stretch 😬
The text was updated successfully, but these errors were encountered: