update new member instructions #835
Conversation
This simplifies new member instructions, and fixes a relative link that doesn't always work. Signed-off-by: Jon Burdo <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
jonburdo
left a comment
jonburdo
left a comment
There was a problem hiding this comment.
This PR is just a few tiny things I wanted to suggest! Happy to adjust if we want some but not all, or close if we want to leave it as is :)
| import os.path as osp | ||
|
|
||
| import yaml | ||
|
|
||
| ORG_YAML = "kubeflow/org.yaml" | ||
|
|
||
| def test_team_member_is_in_org(): | ||
| with open(ORG_YAML) as stream: | ||
| path = osp.join(osp.dirname(__file__), ORG_YAML) | ||
| with open(path) as stream: | ||
| org_data = yaml.safe_load(stream) |
There was a problem hiding this comment.
Make path relative to this script rather than relative to the current working directory. This enables running from a different directory such as the repo's root dir: pytest github-orgs/test_org_yaml.py
| - Modify [github-orgs/kubeflow/org.yaml](github-orgs/kubeflow/org.yaml) to include your GitHub username in the appropriate places. | ||
| - In the `org.kubeflow.members` list | ||
| - If you work for a company that is recognized by the Kubeflow project, then in your company team list (check `org.kubeflow.teams`) | ||
| - Modify [github-orgs/kubeflow/org.yaml](github-orgs/kubeflow/org.yaml) to include your GitHub username in the `org.kubeflow.members` list. |
There was a problem hiding this comment.
It looks to me like org.kubeflow.teams is no longer relevant for new members?
| cd github_orgs | ||
| pytest test_org_yaml.py | ||
| pytest github-orgs/test_org_yaml.py |
There was a problem hiding this comment.
At a minimum github_orgs should be github-orgs
There was a problem hiding this comment.
Also could be more self contained with:
uv run --with pytest pytest github-orgs/test_org_yaml.py
or
pip install pytest && pytest github-orgs/test_org_yaml.py
Probably fine as is though
| - After your PR is merged please wait at least 1 hour for changes to propagate. | ||
| - You will receive an email invite (to your GitHub associated email address) to join Kubeflow on GitHub. Follow the instructions on the email to accept your invitation. | ||
| - If after an hour you haven't received an invite to join the GitHub org (or your invite has expired) please open an issue with an [owner](../../OWNERS) tagged to request follow-up. | ||
| - If after an hour you haven't received an invite to join the GitHub org (or your invite has expired) please open an issue with an [owner](https://github.com/kubeflow/internal-acls/blob/master/OWNERS) tagged to request follow-up. |
There was a problem hiding this comment.
These relative paths work when you view the template file in the repo, but not when you actually create an issue
1 participant
This simplifies new member instructions, and fixes a relative link that doesn't always work.