From 6a0d364caff1e1428222ace7fb031d1d88b83efa Mon Sep 17 00:00:00 2001 From: Rory Carson Date: Thu, 21 Sep 2023 14:08:38 +0200 Subject: [PATCH] remove unneeded docs --- CONTRIBUTING.md | 47 ------------- SECURITY.md | 11 --- code-of-conduct.md | 2 - contributor-ladder.md | 48 ------------- opt-out.md | 156 ------------------------------------------ 5 files changed, 264 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 SECURITY.md delete mode 100644 code-of-conduct.md delete mode 100644 contributor-ladder.md delete mode 100644 opt-out.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 8f6912bb..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,47 +0,0 @@ -# Contributing - -All community members must abide by the [OpenSSF Code of -Conduct.](https://openssf.org/community/code-of-conduct/) - -* Feel free to open issues for bugs, feature requests, discussion, - questions, help, proposals, etc. -* If you want to contribute a small fix or feature, open a PR. -* If you want to contribute something larger, a discussion or proposal - issue may be appropriate. -* Please update docs when contributing features. -* When contributing large features, upate [whats-new.md](whats-new.md) -* All git commits must have [DCO](https://wiki.linuxfoundation.org/dco) - -## Contribitor Ladder - -[contributor-ladder.md](contributor-ladder.md) - -## Community - -Allstar is a project under the [OpenSSF](https://openssf.org/) -[Securing Critical -Projects](https://github.com/ossf/wg-securing-critical-projects) -Working Group ([Mailing -List](https://lists.openssf.org/g/openssf-wg-securing-crit-prjs)). - -Allstar [Slack Channel](https://openssf.slack.com/#allstar) for -discussion. - -Bi-weekly meetings are Thursdays, 1-2pm, Pacific time. See the -[OpenSSF -Calendar](https://calendar.google.com/calendar/u/0?cid=czYzdm9lZmhwNWk5cGZsdGI1cTY3bmdwZXNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) -for the invite. - -## Development - -* Run tests: `go test -v ./...` -* Run lint: `golangci-lint run` -* Local testing: See [operator.md](operator.md) to setup a test instance for yourself. - -## Contribute Policies - -[Interface definition.](pkg/policydef/policydef.go) - -Both the [SECURITY.md](pkg/policies/security/security.go) and [Outside -Collaborators](pkg/policies/outside/outside.go) policies are quite simple to -understand and good examples to copy. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 65b40899..00000000 --- a/SECURITY.md +++ /dev/null @@ -1,11 +0,0 @@ -# Reporting Security Issues - -To report a security issue, please email -[oss-security@googlegroups.com](mailto:oss-security@googlegroups.com) -with a description of the issue, the steps you took to create the issue, -affected versions, and, if known, mitigations for the issue. - -Our vulnerability management team will respond within 3 working days of your -email. If the issue is confirmed as a vulnerability, we will open a -Security Advisory and acknowledge your contributions as part of it. This project -follows a 90 day disclosure timeline. diff --git a/code-of-conduct.md b/code-of-conduct.md deleted file mode 100644 index d83fe17a..00000000 --- a/code-of-conduct.md +++ /dev/null @@ -1,2 +0,0 @@ -All community members must abide by the [OpenSSF Code of -Conduct.](https://openssf.org/community/code-of-conduct/) diff --git a/contributor-ladder.md b/contributor-ladder.md deleted file mode 100644 index ad002284..00000000 --- a/contributor-ladder.md +++ /dev/null @@ -1,48 +0,0 @@ -# Contributor Ladder - -| Name | Prerequisites: Indicators to look for before promotion | Expectations | Recognition, Access, Effect of access | -| - | - | - | - | -| Contributors | One of: 1. Regular PRs for code/docs. 2. Regular feedback on discussion topics in issues/slack 3. Regular meeting attendance and contribution. For a period of time: 30 days or more. | Continue pre-req. | Added as GitHub Outside Collaborator to repo with read permissions. Tests on PRs run automatically without approval | -| Maintainers | Regular PRs for code/docs of moderate to substantial impact. Participates in many high-level proposals and discussions. | Available to have PRs assigned to them for review: Will review within 3 business days, otherwise notifies team when unable to review (ooo, etc.) Responds to requests for input/discussion over issues and slack | Added as GitHub Outside Collaborator to repo with write/push access. Approves and merges PRs | -| Leaders | Consistently drives the project through code, proposals, project direction, leadership, etc. | As a group, responds and makes final decisions through consensus on all large proposals, features, architecture changes, design, documentation of project | Full access and ownership. Creates releases, and finalizes changelog updates, sends project update announcements. | - -## Promotion Process - -Please submit a PR to this file with the promotion proposed, and include -evidence of the proposed member meeting the prerequisites. The proposed member -must agree to uphold the expectations of the new level. The existing -Maintainers and Leaders will reach consensus that the prerequites are met and -merge the PR. - -### Appeals - -Appeals will be discussed as a meeting agneda item in the [Securing Critical -Projects](https://github.com/ossf/wg-securing-critical-projects) Working -Group. Please see the WG page for meeting times. - -## Current list - -### Contributors - -- @coheigea -- @danielbankhead -- @five510 -- @justaugustus -- @markdboyd -- @naveensrinivasan -- @olivekl -- @yorinasub17 - -### Maintainers - -### Leaders - -- @jeffmendoza - -## Notes - -- Only "outside collaborator" access is included above. We would like - to determine OpenSSF GitHub Org membership requirements and add that - at the Maintainer level. - -- Please suggest more recognition items for the Contributor level. diff --git a/opt-out.md b/opt-out.md deleted file mode 100644 index 428a9976..00000000 --- a/opt-out.md +++ /dev/null @@ -1,156 +0,0 @@ -# How to disable Allstar -If you are receiving unwanted issues created by Allstar, follow the instructions on this page to disable the app on your project. - -Allstar is highly configurable, so to disable it you need to know: - -- Whether Allstar was installed at the organization level or directly on your - repository -- Whether Allstar was configured using the opt-in or opt-out strategy - (if it was installed at the organization level) - -If you already know how Allstar is configured on your organization or repository, -follow the instructions for the appropriate configuration: - -[Disable Allstar, org-level opt-out strategy](#disable-allstar-org-level-opt-out-strategy) -[Disable Allstar, org-level opt-in strategy](#disable-allstar-org-level-opt-in-strategy) -[Disable Allstar, repository level](#disable-allstar-repository-level) - -If you did not install Allstar yourself and do not know which instructions to -follow, you should contact your administrator to find out how Allstar is -configured on your organization. - -If you are unable to contact the administrator, you can still disable of -Allstar, but it will take a little more work. Follow [these instructions -](#determine-how-allstar-is-configured)to figure out how Allstar is configured on your project. - -## Determine how Allstar is configured -
- Click to expand - -Follow these instructions if you are unable to contact your administrator to -find out how Allstar is configured on your organization or repository. - -In your organization, find the repository named `.allstar`. - -In the `.allstar` repository, find the file named `allstar.yaml.` - -In that file, look for a setting that says: - -``` - optConfig: - - optOutStrategy: -``` - -- If `optOutStrategy` is set to `true`, follow the [opt-out strategy - instructions](#disable-allstar-org-level-opt-out-strategy). - -- If `optOutStrategy` is set to `false`, follow the [opt-in strategy - instructions](#disable-allstar-org-level-opt-in-strategy). - -If this setting, file, or repository does not exist, it means that your project has been opted-in elsewhere and you will need to determine where: - -Check the org-level `allstar.yaml` file for your repo. It may look like this: - -``` -optConfig: - optInRepos: - - other-repo - - other-repo-two - - my-repo-name-here - - yet-another-repo -``` - -If your repository is on the `optInRepos` list, follow the [opt-in strategy -instructions](#disable-allstar-org-level-opt-in-strategy). - -If your repository is not listed in the allstar.yaml file, it means Allstar is -configured directly on your repository. Follow the [repository-level instructions](#disable-allstar-repository-level). -
- -## Disable Allstar, org-level opt-out strategy - -These instructions disable Allstar on a repository when Allstar is configured at the organization level using the opt-out strategy. - -In the `.allstar` repository in your organization, open the file named -`allstar.yaml`. - -Find the `optOutStrategy` setting: - -``` -optConfig: - optOutStrategy: true -``` - -To opt-out, submit a PR to the `.allstar` repo, and add the name of your -repository to the opt-out list: - -``` -optConfig: - optOutStrategy: true - optOutRepos: - - my-repo-name-here -``` - -Allstar will be disabled on your repository when the pull request is merged. - -### Alternative option: with repo-override - -This alternative option uses the `repo-override` setting to avoid the need to -submit a pull request to the organization's `.allstar` repo, but works only if: - -- the org-level `allstar.yaml` config has the line `disableRepoOverride: - false` - -or - -- the org-level `allstar.yaml` config file does not the include - `disableRepoOverride` setting (which defaults to `false`). - -If `disableRepoOverride` is set to `true`, the following instructions will not -work. - -To disable Allstar using repo-override, create a file in your repo named -`.allstar/allstar.yaml` with the contents: - -``` -optConfig: - optOut: true -``` - -Merge this file to disable Allstar on your repository. - -## Disable Allstar, org-level opt-in strategy - -These instructions disable Allstar on a repository when Allstar is configured at the organization level using the opt-in strategy. - -In the org-level .allstar repository, open the `allstar.yaml` file. Find the -`optInRepos` setting: - -``` -optConfig: - optInRepos: - - other-repo - - other-repo-two - - my-repo-name-here - - yet-another-repo -``` - -Submit a pull request to the `.allstar` repo that removes your repo name from that list. - -When the pull request is merged, Allstar should be disabled on your repository. If you still continue to receive issues, though, it means your project was also opted-in at the repository level. You must also follow the [repository-level instructions](disable-allstar-repository-level). - -## Disable Allstar, repository level - -These instructions disable Allstar when it is configured directly on your repository (not at the organization level). - -Look in your repository for a file named `.allstar/allstar.yaml`. It - should contain this setting: - -``` -optConfig: - optIn: true -``` - -Remove the `.allstar/allstar.yaml` file from your repository to - disable Allstar.