Skip to content
This repository has been archived by the owner on Feb 13, 2023. It is now read-only.

Documentation around organization settings is inconsistent #263

Closed
JoshuaTheMiller opened this issue May 5, 2021 · 6 comments · Fixed by #360
Closed

Documentation around organization settings is inconsistent #263

JoshuaTheMiller opened this issue May 5, 2021 · 6 comments · Fixed by #360
Labels
bug Something isn't working

Comments

@JoshuaTheMiller
Copy link
Contributor

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 the ORG_CONFIG_REPO_NAME environment variable is set to something else). Elsewhere, documentation states that the default value of ORG_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:

  1. Look at the README

Expected behavior
For the README to be consistent.

Screenshots

image

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 😬

@JoshuaTheMiller JoshuaTheMiller added the bug Something isn't working label May 5, 2021
@zkoppert
Copy link
Member

zkoppert commented May 7, 2021

This makes sense and is fairly straight forward. Would you like to open a pull request to fix this @JoshuaTheMiller?

@JoshuaTheMiller
Copy link
Contributor Author

@zkoppert, if no one beats me to it, yes 🙂

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity.
It will be closed in 14 days if no further activity occurs.
Thank you for your contributions.

If you think this issue should stay open, please remove the O: stale 🤖 label or comment on the issue.

@JoshuaTheMiller
Copy link
Contributor Author

(I really do plan on getting to this)

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity.
It will be closed in 14 days if no further activity occurs.
Thank you for your contributions.

If you think this issue should stay open, please remove the O: stale 🤖 label or comment on the issue.

@JoshuaTheMiller
Copy link
Contributor Author

Finally getting to this.... 😅

JoshuaTheMiller added a commit to JoshuaTheMiller/rally that referenced this issue Jan 25, 2022
JoshuaTheMiller added a commit to JoshuaTheMiller/rally that referenced this issue Jan 25, 2022
JoshuaTheMiller added a commit to JoshuaTheMiller/rally that referenced this issue Jan 26, 2022
JoshuaTheMiller added a commit to JoshuaTheMiller/rally that referenced this issue Jan 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants