From 3721632de273f7998de39b425935ef6b1ce86cf4 Mon Sep 17 00:00:00 2001 From: Matt Moyer Date: Thu, 18 Feb 2021 10:10:35 -0600 Subject: [PATCH] Move scope doc out of website to SCOPE.md. This is contributor-focused, so we decided to move it into GitHub only for now. Signed-off-by: Matt Moyer --- CONTRIBUTING.md | 2 +- SCOPE.md | 32 ++++++++++++++++++++++++++++ site/content/docs/scope.md | 43 -------------------------------------- 3 files changed, 33 insertions(+), 44 deletions(-) create mode 100644 SCOPE.md delete mode 100644 site/content/docs/scope.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20d3e1bf..c00094b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Please see the [Code of Conduct](./CODE_OF_CONDUCT.md). ## Project Scope -Learn about the [scope](https://pinniped.dev/docs/scope/) of the project. +See [SCOPE.md](./SCOPE.md) for some guidelines about what we consider in and out of scope for Pinniped. ## Community Meetings diff --git a/SCOPE.md b/SCOPE.md new file mode 100644 index 00000000..91dff3bd --- /dev/null +++ b/SCOPE.md @@ -0,0 +1,32 @@ +# Project Scope + +The Pinniped project is guided by the following principles. + +- Pinniped lets you plug any external identity providers into Kubernetes. + These integrations follow enterprise-grade security principles. +- Pinniped is easy to install and use on any Kubernetes cluster via distribution-specific integration mechanisms. +- Pinniped uses a declarative configuration via Kubernetes APIs. +- Pinniped provides optimal user experience when authenticating to many clusters at one time. +- Pinniped provides enterprise-grade security posture via secure defaults and revocable or very short-lived credentials. +- Where possible, Pinniped will contribute ideas and code to upstream Kubernetes. + +When contributing to Pinniped, please consider whether your contribution follows +these guiding principles. + +## Out Of Scope + +The following items are out of scope for the Pinniped project. + +- Authorization. +- Standalone identity provider for general use. +- Machine-to-machine (service) identity. +- Running outside of Kubernetes. + +## Roadmap + +See our [open milestones][milestones] and the [`priority/backlog` label][backlog] for an idea about what's next on our roadmap. + +For more details on proposing features and bugs, check out our [contributing](./CONTRIBUTING.md) doc. + +[milestones]: https://github.com/vmware-tanzu/pinniped/milestones +[backlog]: https://github.com/vmware-tanzu/pinniped/labels/priority%2Fbacklog \ No newline at end of file diff --git a/site/content/docs/scope.md b/site/content/docs/scope.md deleted file mode 100644 index 09cedc2c..00000000 --- a/site/content/docs/scope.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "Pinniped Scope" -cascade: - layout: docs -menu: - docs: - name: Scope - weight: 200 ---- - - -# Project Scope - -The Pinniped project is guided by the following principles. -* Pinniped lets you plug any external identity providers into - Kubernetes. These integrations follow enterprise-grade security principles. -* Pinniped is easy to install and use on any Kubernetes cluster via - distribution-specific integration mechanisms. -* Pinniped uses a declarative configuration via Kubernetes APIs. -* Pinniped provides optimal user experience when authenticating to many - clusters at one time. -* Pinniped provides enterprise-grade security posture via secure defaults and - revocable or very short-lived credentials. -* Where possible, Pinniped will contribute ideas and code to upstream - Kubernetes. - -When contributing to Pinniped, please consider whether your contribution follows -these guiding principles. - -## Out Of Scope - -The following items are out of scope for the Pinniped project. -* Authorization. -* Standalone identity provider for general use. -* Machine-to-machine (service) identity. -* Running outside of Kubernetes. - -## Roadmap - -More details coming soon! - -For more details on proposing features and bugs, check out our -[contributing](https://github.com/vmware-tanzu/pinniped/blob/main/CONTRIBUTING.md) doc.