-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Update docs to be inline with templates
Signed-off-by: Chris Privitere <[email protected]>
- Loading branch information
1 parent
de26a15
commit 91c09a9
Showing
7 changed files
with
268 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Code Of Conduct | ||
# Kubernetes Community Code of Conduct | ||
|
||
Please refer to the [Contributor Covenant](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct/). | ||
Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# See the OWNERS docs at https://go.k8s.io/owners | ||
|
||
approvers: | ||
- sig-cloud-provider-leads | ||
- cloud-provider-equinix-metal-maintainers | ||
|
||
reviewers: | ||
- cloud-provider-equinix-metal-maintainers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# See the OWNERS docs at https://go.k8s.io/owners#owners_aliases | ||
|
||
aliases: | ||
sig-cloud-provider-leads: | ||
- andrewsykim | ||
- cheftako | ||
- nckturner | ||
cloud-provider-equinix-metal-maintainers: | ||
- cprivitere | ||
- deitch | ||
- displague |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Release | ||
|
||
This document describes how to release the Equinix Metal Cloud Provider. | ||
|
||
This is _not_ intended for regular users. | ||
|
||
This is normally performed by our CI system. However, there are important steps to take first. | ||
|
||
## How to Cut a Release | ||
|
||
In order to cut a release, you must: | ||
|
||
1. Commit the changes. | ||
1. Push out your branch, open a PR and merge the changes | ||
1. Wait for the Continuous Integration github action to finish running | ||
1. Tag the release with `git tag -a vX.Y.z -m "Message" | ||
1. Push out the tag | ||
|
||
## How A Release Happens | ||
|
||
* GitHub Actions detects a new tag has been pushed | ||
* CI builds docker images for each supported architecture as well as a multi-arch manifest, and tags it with the semver tag of the release, e.g. `v0.4.0` | ||
* CI creates the release in `out/release`, the equivalent of `make release` | ||
* CI copies the artifacts in `out/release/*` to the github releases |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Security Policy | ||
|
||
## Security Announcements | ||
|
||
Join the [kubernetes-security-announce] group for security and vulnerability announcements. | ||
|
||
## Reporting a Vulnerability | ||
|
||
Instructions for reporting a vulnerability can be found on the | ||
[Kubernetes Security and Disclosure Information] page. | ||
|
||
## Supported Versions | ||
|
||
Information about supported Kubernetes versions can be found on the | ||
[Kubernetes version and version skew support policy] page on the Kubernetes website. | ||
|
||
[kubernetes-security-announce]: https://groups.google.com/forum/#!forum/kubernetes-security-announce | ||
[Kubernetes version and version skew support policy]: https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions | ||
[Kubernetes Security and Disclosure Information]: https://kubernetes.io/docs/reference/issues-security/security/#report-a-vulnerability |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Defined below are the security contacts for this repo. | ||
# | ||
# They are the contact point for the Security Response Committee to reach out | ||
# to for triaging and handling of incoming issues. | ||
# | ||
# The below names agree to abide by the | ||
# [Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy) | ||
# and will be removed and replaced if they violate that agreement. | ||
# | ||
# DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE | ||
# INSTRUCTIONS AT https://kubernetes.io/security/ | ||
|
||
displague | ||
cprivitere |