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

fix: typos in documentation files #86

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ To learn more, check out:
## Tips / FYIs
* [github/filecoin-project.yml](https://github.com/filecoin-project/github-mgmt/blob/master/github/filecoin-project.yml) is the key file where updates are made to adjust permissions.
* "github-mgmt" was the old name. The original template repo is now called "github-as-code". We use the terms interchangably in comments/docs.
* Yes, it's confusing to have a `.github` and `github` directory. That is how gitub-mgmt was originally setup an we're living with it. (At least of 2024-09-05, there is [no backlog item for cleaning this up](https://github.com/ipdxco/github-as-code/issues?page=1&q=is%3Aissue+is%3Aopen).)
* Yes, it's confusing to have a `.github` and `github` directory. That is how GitHub-mgmt was originally setup an we're living with it. (At least of 2024-09-05, there is [no backlog item for cleaning this up](https://github.com/ipdxco/github-as-code/issues?page=1&q=is%3Aissue+is%3Aopen).)
* Not all [organization-level roles](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) are assignable through github-mgmt. For example, organization moderators, billing managers, and ecurity managers need to set through the GitHub UI.
* github-mgmt calls [GitHub organization owners](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners) as "admins" in [filecoin-project.yml](https://github.com/filecoin-project/github-mgmt/blob/master/github/filecoin-project.yml). These terms are used interchangably in comments/docs.
* At least as of 202409, AWS resources that terraform uses behind the scenes (e.g., S3 bucket, DDB table) are all stored in an ipdx.co-managed AWS account.
* Repo creation is still performed through the GitHub UI. The repo then gets "added" to github-mgmt mgmt as part of the [sync workflow](https://github.com/filecoin-project/github-mgmt/blob/master/.github/workflows/sync.yml), which runs weekly automatically and can be done on demand as well.

## Organization Owner SOPs
Below is documentation/expecations [filecoin-project owners](https://github.com/orgs/filecoin-project/people?query=role%3Aowner).
Below is documentation/expectations [filecoin-project owners](https://github.com/orgs/filecoin-project/people?query=role%3Aowner).

### General
1. Have 2FA enabled on GitHub account
2. Be part of #filecoin-project-owners FIL Slack private channel

### Handling App Installation Requests
1. Per [docs](https://docs.github.com/en/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner), org owners have to approve these requests.
2. Pending insallations can be reviewed at https://github.com/organizations/filecoin-project/settings/installations
2. Pending installations can be reviewed at https://github.com/organizations/filecoin-project/settings/installations
* New installation requests also come in via GitHub notificaitons to owners.
3. Before approving the installation, ensure you have connected directly with the requester to understand their usecase and to ensure we're scoping down app access as much possible. For example, it's better if an app only need access to specific repos than to the whole organization, especially if the app is created by a 3rd party and/or needs write permissions.
4. After approving, create a "log" of the approval by writing a message in #filecoin-project-owners following this template:
Expand All @@ -49,11 +49,11 @@ To remove someone, an org admin should follow these steps:
1. (anyone) Open a PR that removes the member from all teams and repositories and leaves a comment next to their name saying they'll be manually removed via the UI. We do this so there is record in the commit history of the intent of the change.
2. Get the PR approved per normal process.
3. (github-mgmt-steward) Merge the PR.
4. (org owner) Confrim in https://github.com/filecoin-project/github-mgmt/actions that the actions are applied.
4. (org owner) Confirm in https://github.com/filecoin-project/github-mgmt/actions that the actions are applied.
5. (org owner) Access the user in the GitHub UI at https://github.com/orgs/filecoin-project/people/USERNAME
6. (org owner) Remove the user from the organization via the "Remove from organization" button.
7. (org owner) Grab a screenshot
8. (org owner) [Run the sync workflow](https://github.com/filecoin-project/github-mgmt/actions/workflows/sync.yml) to remove the user from the terraform state
9. (org owner) Post back in the original PR that the user has been fully removed, including the screenshot and a link to the sync workflow run.

https://github.com/filecoin-project/github-mgmt/pull/66 is an example of this process.
https://github.com/filecoin-project/github-mgmt/pull/66 is an example of this process.
2 changes: 1 addition & 1 deletion docs/HOWTOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ I push my changes to a new branch and create a PR. An admin reviews the PR and m

### ...synchronize GitHub Management with GitHub?

*NOTE*: Remember that the `Sync` operation modifes terraform state. Even if you run it from a branch, it modifies the global state that is shared with other branches. There is only one terraform state per organization.
*NOTE*: Remember that the `Sync` operation modifies terraform state. Even if you run it from a branch, it modifies the global state that is shared with other branches. There is only one terraform state per organization.

*NOTE*: `Sync` will force push changes directly to the branch you run it from.

Expand Down
2 changes: 1 addition & 1 deletion docs/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@
- [ ] Manually set values that are impossible to control this value via terraform currently
- [ ] [Set read repository contents permissions for `GITHUB_TOKEN`](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)
- [ ] If the repository is public, [require approval for all outside collaborators](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks)
- [ ] If the repository is private, [disable sending write tokens or secrets to worfklows from fork pull requests](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)
- [ ] If the repository is private, [disable sending write tokens or secrets to workflows from fork pull requests](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)
- [ ] Pull remote changes to the default branch
- [ ] Enable required PRs, peer reviews, status checks and branch up-to-date check on the repository by making sure [github/$ORGANIZATION_NAME.yml](github/$ORGANIZATION_NAME.yml) contains the following entry:
```yaml
Expand Down
Loading