From ed991674ffb992a432746eab2cf80113eb173c4f Mon Sep 17 00:00:00 2001 From: Chris Privitere <23177737+cprivitere@users.noreply.github.com> Date: Fri, 30 Jun 2023 16:53:57 -0500 Subject: [PATCH 1/2] docs: update standard files Signed-off-by: Chris Privitere <23177737+cprivitere@users.noreply.github.com> --- .github/workflows/linters/.markdown-lint.yml | 6 + CODEOWNERS | 1 + CODE_OF_CONDUCT.md | 128 +++++++++++++++++++ LICENSE | 21 +++ README.md | 6 + experimental-statement.md | 21 +++ 6 files changed, 183 insertions(+) create mode 100644 .github/workflows/linters/.markdown-lint.yml create mode 100644 CODEOWNERS create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE create mode 100644 experimental-statement.md diff --git a/.github/workflows/linters/.markdown-lint.yml b/.github/workflows/linters/.markdown-lint.yml new file mode 100644 index 0000000..d83fc67 --- /dev/null +++ b/.github/workflows/linters/.markdown-lint.yml @@ -0,0 +1,6 @@ +# MD013/line-length - Line length +MD013: + # Number of characters, default is 80 + line_length: 9999 + # check code blocks? + code_blocks: false diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..602aeb9 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @equinix-labs/governor-devrel-engineering \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..86cbd40 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +devrel [at] equinix [dot] com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7969dac --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Equinix Labs + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 2575168..4fba34d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # metal-runner-action +[![Experimental](https://img.shields.io/badge/Stability-Experimental-red.svg)](experimental-statement.md#experimental-statement) + [![GitHub Super-Linter](https://github.com/equinix-labs/metal-action-runner/actions/workflows/superlinter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter) This Experimental GitHub Action sets up an Equinix Metal server that can be used to run code in your workflows. @@ -89,3 +91,7 @@ jobs: projectID: ${{ needs.Project.outputs.projectID }} keepProject: false ``` + +## Support + +This repository is [Experimental](experimental-statement.md) meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. diff --git a/experimental-statement.md b/experimental-statement.md new file mode 100644 index 0000000..4a82da9 --- /dev/null +++ b/experimental-statement.md @@ -0,0 +1,21 @@ +# Experimental Statement + +## Link Sentence + +This repository is [Experimental](https://github.com/equinix-labs/equinix-labs/blob/main/experimental-statement.md)! + +## Short Statement + +This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. + +## Extended Statement + +This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. + +An experiment is a procedure carried out to support, refute, or validate a hypothesis. Experiments provide insight into cause-and-effect by demonstrating what outcome occurs when a particular factor is manipulated. Experiments vary greatly in goal and scale, but always rely on repeatable procedure and logical analysis of the results. + +You, my friend, have found an experiment. + +There’s a strong sense of open source altruism at Equinix Metal. Most of us have grown up in a world transformed by open software and we see the value in transparency and community efforts. We have also built our core platform and business value on the backs of critical open source technologies from Golang and Ruby to Kubernetes and Postgres. + +Because of our passion for open source, we often develop our software in the open, putting it online long before it's reached stability or the final phase of its journey. And because we'd love to hear from you - receive your collaboration and input on a project, long before it's polished and pristine - we're putting this repository online, with an open source license, and a qualifier, so you know what you're playing with. From 91b5633528aabc32d94d3eb6499abe80d5a03584 Mon Sep 17 00:00:00 2001 From: Chris Privitere <23177737+cprivitere@users.noreply.github.com> Date: Mon, 17 Jul 2023 13:59:49 -0500 Subject: [PATCH 2/2] docs: use centralized experimental statement Signed-off-by: Chris Privitere <23177737+cprivitere@users.noreply.github.com> --- README.md | 4 ++-- experimental-statement.md | 21 --------------------- 2 files changed, 2 insertions(+), 23 deletions(-) delete mode 100644 experimental-statement.md diff --git a/README.md b/README.md index 4fba34d..812581b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # metal-runner-action -[![Experimental](https://img.shields.io/badge/Stability-Experimental-red.svg)](experimental-statement.md#experimental-statement) +[![Experimental](https://img.shields.io/badge/Stability-Experimental-red.svg)](https://github.com/equinix-labs/equinix-labs/blob/main/experimental-statement.md#experimental-statement) [![GitHub Super-Linter](https://github.com/equinix-labs/metal-action-runner/actions/workflows/superlinter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter) @@ -94,4 +94,4 @@ jobs: ## Support -This repository is [Experimental](experimental-statement.md) meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. +This repository is [Experimental](https://github.com/equinix-labs/equinix-labs/blob/main/experimental-statement.md) meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. diff --git a/experimental-statement.md b/experimental-statement.md deleted file mode 100644 index 4a82da9..0000000 --- a/experimental-statement.md +++ /dev/null @@ -1,21 +0,0 @@ -# Experimental Statement - -## Link Sentence - -This repository is [Experimental](https://github.com/equinix-labs/equinix-labs/blob/main/experimental-statement.md)! - -## Short Statement - -This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. - -## Extended Statement - -This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production. - -An experiment is a procedure carried out to support, refute, or validate a hypothesis. Experiments provide insight into cause-and-effect by demonstrating what outcome occurs when a particular factor is manipulated. Experiments vary greatly in goal and scale, but always rely on repeatable procedure and logical analysis of the results. - -You, my friend, have found an experiment. - -There’s a strong sense of open source altruism at Equinix Metal. Most of us have grown up in a world transformed by open software and we see the value in transparency and community efforts. We have also built our core platform and business value on the backs of critical open source technologies from Golang and Ruby to Kubernetes and Postgres. - -Because of our passion for open source, we often develop our software in the open, putting it online long before it's reached stability or the final phase of its journey. And because we'd love to hear from you - receive your collaboration and input on a project, long before it's polished and pristine - we're putting this repository online, with an open source license, and a qualifier, so you know what you're playing with.