From f088594774c683fe9c6a1e7f560de2578a848bc2 Mon Sep 17 00:00:00 2001 From: Mike Ng Date: Fri, 27 Nov 2020 13:24:37 -0500 Subject: [PATCH] update readme Signed-off-by: Mike Ng --- README.md | 44 ++++++++++++++------------------------------ SECURITY.md | 3 +-- 2 files changed, 15 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 1d188f5..706c6fd 100644 --- a/README.md +++ b/README.md @@ -12,48 +12,32 @@ - [multicloud-operators-deployable](#multicloud-operators-deployable) - [What is the multicloud-operators-deployable](#what-is-the-multicloud-operators-deployable) - - [Community, discussion, contribution, and support](#community-discussion-contribution-and-support) - [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Deployment](#deployment) - - [Security Response](#security-response) - [References](#references) - - [multicloud-operators repositories](#multicloud-operators-repositories) -## What is the multicloud-operators-deployable +## What is the multicloud-operators-deployable? -Deployable operator propagate the templating of resources to the target cluster namespace on hub, which will be subscribed later by the subscription operator on the target cluster. +The `multicloud-operators-deployable` is the operator that propagates the templating of resources to the target cluster namespace on hub, which will be subscribed later by the subscription operator on the target cluster. -## Community, discussion, contribution, and support +Go to the [Contributing guide](CONTRIBUTING.md) to learn how to get involved. -Check the [CONTRIBUTING Doc](CONTRIBUTING.md) for how to contribute to the repo. +## Getting started ------- +- Clone and build an image with the [Development guide](docs/development.md). -## Getting Started +- View the [Deployment guide](docs/deployment.md) to learn how to deploy the operator. -### Prerequisites - -Check the [Development Doc](docs/development.md) for how to contribute to the repo. - -### Deployment - -Check the [Deployment Doc](docs/deployment.md) for how to deploy the operator. - -## Security Response - -Check the [Security Doc](SECURITY.md) if you've found a security issue. +- Check the [Security guide](SECURITY.md) if you need to report a security issue. ## References -### multicloud-operators repositories - -- [multicloud-operators-application](https://github.com/open-cluster-management/multicloud-operators-application) -- [multicloud-operators-channel](https://github.com/open-cluster-management/multicloud-operators-channel) -- [multicloud-operators-deployable](https://github.com/open-cluster-management/multicloud-operators-deployable) -- [multicloud-operators-placementrule](https://github.com/open-cluster-management/multicloud-operators-placementrule) -- [multicloud-operators-subscription](https://github.com/open-cluster-management/multicloud-operators-subscription) -- [multicloud-operators-subscription-release](https://github.com/open-cluster-management/multicloud-operators-subscription-release) +- Access the following multicloud-operators repositories: + - [multicloud-operators-application](https://github.com/open-cluster-management/multicloud-operators-application) + - [multicloud-operators-channel](https://github.com/open-cluster-management/multicloud-operators-channel) + - [multicloud-operators-deployable](https://github.com/open-cluster-management/multicloud-operators-deployable) + - [multicloud-operators-placementrule](https://github.com/open-cluster-management/multicloud-operators-placementrule) + - [multicloud-operators-subscription](https://github.com/open-cluster-management/multicloud-operators-subscription) + - [multicloud-operators-subscription-release](https://github.com/open-cluster-management/multicloud-operators-subscription-release) diff --git a/SECURITY.md b/SECURITY.md index 1c6e25c..5a173ab 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,4 +1,3 @@ # Security Response -If you've found a security issue that you'd like to disclose confidentially please contact Red Hat's Product Security team. -Details at https://access.redhat.com/security/team/contact +If you've found a security issue that you'd like to disclose confidentially, please contact the Red Hat Product Security team. Find details at [RedHat Security Contacts and Procedures](https://access.redhat.com/security/team/contact).