Skip to content

Commit

Permalink
Change excluding terms into inclusive alternatives (#11084)
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolina Zydek authored Apr 13, 2021
1 parent 06755b5 commit edf5d9d
Show file tree
Hide file tree
Showing 77 changed files with 195 additions and 195 deletions.
2 changes: 1 addition & 1 deletion .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Thank you for your contribution. Before you submit the pull request:
1. Follow contributing guidelines, templates, the recommended Git workflow, and any related documentation.
2. Read and submit the required Contributor Licence Agreements (https://github.com/kyma-project/community/blob/master/contributing/02-contributing.md#agreements-and-licenses).
2. Read and submit the required Contributor Licence Agreements (https://github.com/kyma-project/community/blob/main/contributing/02-contributing.md#agreements-and-licenses).
3. Test your changes and attach their results to the pull request.
4. Update the relevant documentation.
-->
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of conduct

Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/master/CODE_OF_CONDUCT.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/main/CODE_OF_CONDUCT.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Overview

To contribute to this project, follow the rules from the general [CONTRIBUTING.md](https://github.com/kyma-project/community/blob/master/CONTRIBUTING.md) document in the `community` repository.
To contribute to this project, follow the rules from the general [CONTRIBUTING.md](https://github.com/kyma-project/community/blob/main/CONTRIBUTING.md) document in the `community` repository.

## Documentation types

These are the main types of documents used in the project:

* `NOTES.txt`- This document type is an integral part of Helm charts. Its content displays in the terminal window after installing the chart. It is not mandatory to include `NOTES.txt` documents for sub-charts because the system ignores these documents. Provide `NOTES.txt` documents for the Core components. Use the [template](https://github.com/kyma-project/community/blob/master/guidelines/templates/resources/NOTES.txt) to create `NOTES.txt` documents.
* `NOTES.txt`- This document type is an integral part of Helm charts. Its content displays in the terminal window after installing the chart. It is not mandatory to include `NOTES.txt` documents for sub-charts because the system ignores these documents. Provide `NOTES.txt` documents for the Core components. Use the [template](https://github.com/kyma-project/community/blob/main/guidelines/templates/resources/NOTES.txt) to create `NOTES.txt` documents.

* `README.md` - This document type contains information about other files in the directory. Each main directory in this repository, such as `cluster` or `resources`, requires a `README.md` document. Additionally, each chart and sub-chart needs such a document. Add a `README.md` document when you create a new directory or chart. Use the [template](https://github.com/kyma-project/community//blob/master/guidelines/templates/resources/chart_README.md) to create `README.md` documents.
* `README.md` - This document type contains information about other files in the directory. Each main directory in this repository, such as `cluster` or `resources`, requires a `README.md` document. Additionally, each chart and sub-chart needs such a document. Add a `README.md` document when you create a new directory or chart. Use the [template](https://github.com/kyma-project/community//blob/main/guidelines/templates/resources/chart_README.md) to create `README.md` documents.

> **NOTE:** `README.md` documents imported to Kyma with external charts don't have to follow the template.
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/kyma-project/kyma/master/logo.png" width="235">
<img src="https://raw.githubusercontent.com/kyma-project/kyma/main/logo.png" width="235">
</p>

[![Go Report Card](https://goreportcard.com/badge/github.com/kyma-project/kyma)](https://goreportcard.com/report/github.com/kyma-project/kyma)
Expand All @@ -11,7 +11,7 @@

**Kyma** `/kee-ma/` is a platform for extending applications with microservices and [serverless](https://kyma-project.io/docs/components/serverless/#overview-overview) Functions. It provides CLI and UI through which you can connect your application to a Kubernetes cluster. You can also expose the application's API or events securely thanks to the built-in [Application Connector](https://kyma-project.io/docs/components/application-connector/#overview-overview). You can then implement the business logic you require by creating microservices or serverless Functions. Trigger them to react to particular events or calls to your application's API.

To limit the time spent on coding, use the built-in cloud services from [Service Catalog](https://kyma-project.io/docs/master/components/service-catalog/#overview-service-catalog), exposed by [Service Brokers](https://kyma-project.io/docs/master/components/service-catalog/#overview-service-brokers) from such cloud providers as GCP, Azure, and AWS.
To limit the time spent on coding, use the built-in cloud services from [Service Catalog](https://kyma-project.io/docs/components/service-catalog/#overview-service-catalog), exposed by [Service Brokers](https://kyma-project.io/docs/components/service-catalog/#overview-service-brokers) from such cloud providers as GCP, Azure, and AWS.

<p align="center">
<a href="https://youtu.be/kP7mSELIxXw">
Expand Down Expand Up @@ -75,18 +75,18 @@ Follow these steps:
[Read](https://kyma-project.io/#used-by) how these companies use Kyma:

<p align="center">
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/sap.svg" alt="SAP" width="120" height="70" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/accenture.svg" alt="Accenture" width="300" height="70" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/netconomy.svg" alt="NETCONOMY" width="300" height="70" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/neteleven.svg" alt="neteleven" width="250" height="60" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/sap.svg" alt="SAP" width="120" height="70" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/accenture.svg" alt="Accenture" width="300" height="70" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/netconomy.svg" alt="NETCONOMY" width="300" height="70" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/neteleven.svg" alt="neteleven" width="250" height="60" />
</p>
<p align="center">
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/arithnea.svg" alt="ARITHNEA" width="300" height="130" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/digital_lights.svg" alt="Digital Lights" width="200" height="130" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/FAIR_LOGO_HEADER.svg" alt="FAIR" width="300" height="130" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/Sybit-Logo.svg" alt="FAIR" width="300" height="130" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/arithnea.svg" alt="ARITHNEA" width="300" height="130" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/digital_lights.svg" alt="Digital Lights" width="200" height="130" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/FAIR_LOGO_HEADER.svg" alt="FAIR" width="300" height="130" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/Sybit-Logo.svg" alt="FAIR" width="300" height="130" />
</p>
<p align="center">
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/arineo.svg" alt="Arineo" width="250" height="40" />
<img src="https://github.com/kyma-project/website/blob/master/content/adopters/logos/dotsource.svg" alt="dotSource" width="250" height="40" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/arineo.svg" alt="Arineo" width="250" height="40" />
<img src="https://github.com/kyma-project/website/blob/main/content/adopters/logos/dotsource.svg" alt="dotSource" width="250" height="40" />
</p>
2 changes: 1 addition & 1 deletion common/makefiles/docs/generic-make-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ BUILDPACK = {BUILDPACK IMAGE}
SCRIPTS_DIR = {GENERIC MAKEFILE PATH}
include $(SCRIPTS_DIR)/generic-make-go.mk
```
Find the list of available buildpack images [here](https://github.com/kyma-project/test-infra/blob/master/templates/config.yaml).
Find the list of available buildpack images [here](https://github.com/kyma-project/test-infra/blob/main/templates/config.yaml).

## Usage
This is the basic syntax used in Makefiles:
Expand Down
2 changes: 1 addition & 1 deletion components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ This table lists the available types:

## Development

Follow [this](https://github.com/kyma-project/kyma/blob/master/resources/README.md) development guide when you add a new component to the `kyma` repository.
Follow [this](https://github.com/kyma-project/kyma/blob/main/resources/README.md) development guide when you add a new component to the `kyma` repository.
2 changes: 1 addition & 1 deletion components/application-broker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To set up the project, download these tools:
* [Dep](https://github.com/golang/dep) v0.5.0
* [Docker](https://www.docker.com/)

These Go and Dep versions are compliant with the `buildpack` used by Prow. For more details read [this](https://github.com/kyma-project/test-infra/blob/master/prow/images/buildpack-golang/README.md) document.
These Go and Dep versions are compliant with the `buildpack` used by Prow. For more details read [this](https://github.com/kyma-project/test-infra/blob/main/prow/images/buildpack-golang/README.md) document.

## Development

Expand Down
2 changes: 1 addition & 1 deletion components/application-broker/cmd/poc-events/findings.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Currently changing status of custom resource does not work. Probably will be rel

#### Detailed description
Currently changing status of custom resource does not work, but [proposal](https://github.com/kubernetes/community/pull/913) is already accepted.
Implementation is also merged to master and tagged with version: "v1.10.0-beta.4". See [Add subresources for custom resources](https://github.com/kubernetes/kubernetes/pull/55168/commits/6fbe8157e39f6bd7ad885a8a6f8614e2fe45dc5e)
Implementation is also merged to the `master` branch and tagged with version: "v1.10.0-beta.4". See [Add subresources for custom resources](https://github.com/kubernetes/kubernetes/pull/55168/commits/6fbe8157e39f6bd7ad885a8a6f8614e2fe45dc5e)

So currently we get following error when calling UpdateStatus method.
```text
Expand Down
8 changes: 4 additions & 4 deletions components/binding/docs/03-binding-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Kyma Binding pipelines are based on GitHub Actions and use k3s that provides [the best infrastructure](https://github.com/kyma-incubator/local-kyma#i-see-k3s-k3d-kind-and-minikube---what-should-i-use) to run the CI on. The script to run k3s is based on [this script](https://github.com/kyma-incubator/local-kyma/blob/main/create-cluster-k3s.sh). As GitHub doesn't propagate the secrets created on the main repository to pull requests opened from forked repositories and the workflow in Kyma is based on using forks, we had to create a workaround based on [this solution](https://github.com/imjohnbo/ok-to-test). For this purpose, the following jobs were developed:

- [`Is trusted dev`](https://github.com/kyma-project/kyma/blob/master/.github/workflows/trusted-dev.yaml)
- [`Ok to test`](https://github.com/kyma-project/kyma/blob/master/.github/workflows/ok-to-test.yaml)
- [`Pre-master binding k3s`](https://github.com/kyma-project/kyma/blob/master/.github/workflows/pre-master-binding-k3s.yml)
- [`Post-master binding k3s`](https://github.com/kyma-project/kyma/blob/master/.github/workflows/post-master-binding-k3s.yml)
- [`Is trusted dev`](https://github.com/kyma-project/kyma/blob/main/.github/workflows/trusted-dev.yaml)
- [`Ok to test`](https://github.com/kyma-project/kyma/blob/main/.github/workflows/ok-to-test.yaml)
- [`Pre-master binding k3s`](https://github.com/kyma-project/kyma/blob/main/.github/workflows/pre-master-binding-k3s.yml)
- [`Post-master binding k3s`](https://github.com/kyma-project/kyma/blob/main/.github/workflows/post-master-binding-k3s.yml)

## `Is trusted dev` job

Expand Down
2 changes: 1 addition & 1 deletion components/console-backend-service/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Overview
To contribute to this project, follow the rules from the general [CONTRIBUTING.md](https://github.com/kyma-project/community/blob/master/CONTRIBUTING.md) document in the `community` repository.
To contribute to this project, follow the rules from the general [CONTRIBUTING.md](https://github.com/kyma-project/community/blob/main/CONTRIBUTING.md) document in the `community` repository.
For additional, project-specific guidelines, see the respective sections of this document.

## Contribution rules
Expand Down
4 changes: 2 additions & 2 deletions components/console-backend-service/docs/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The application checks if the Authorization token passed by the user is signed b

## Overview

The Console Backend Service uses a GraphQL implementation for authorization. Read [this](https://kyma-project.io/docs/master/components/security#details-graph-ql)) document for more details.
The Console Backend Service uses a GraphQL implementation for authorization. Read [this](https://kyma-project.io/docs/components/security/#details-graph-ql) document for more details.

## How to secure a GraphQL action

Expand All @@ -28,7 +28,7 @@ Reference this table for details on the elements that make up a defined and secu
| `: [LimitRange!]!` | Defines the type of object returned by the query. In this case, it's a list of LimitRanges resources. |
| `@HasAccess(attributes:` | Defines the GraphQL directive that secures access to the resource. |
| `resource: "limitranges"` | Defines the type of secured Kubernetes resource, in this case all `limitranges` resources. |
| `verb: "list"` | Defines the secured interaction type. It is related to action type, which in this case is "query". Use the the table from [this paragraph](https://kyma-project.io/docs/master/components/security#details-graph-ql) to choose the right verb. |
| `verb: "list"` | Defines the secured interaction type. It is related to action type, which in this case is "query". Use the the table from [this paragraph](https://kyma-project.io/docs/components/security/#details-graph-ql) to choose the right verb. |
| `apiGroup: ""` | Defines the apiGroup to which the user must have access to get the result of this query. In this case it is empty because limitRanges is the resource built into Kubernetes, not some Custom Resource created by us. |
| `apiVersion: "v1alpha1"` | Specifies the apiVersion of the query subject. |
| `namespaceArg: "namespace"` | Specifies the name of the argument or field in the parent object from which the resource namespace is fetched. |
Expand Down
10 changes: 5 additions & 5 deletions components/eventing-controller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Overview

This component contains controllers for various CustomResourceDefinitions related to eventing in Kyma. The following controllers come with this container:
- [`controller`](https://github.com/kyma-project/kyma/blob/master/components/eventing-controller/cmd/eventing-controller/main.go) which lays down the eventing infrastructure in Business Event Bus (BEB).
- [`nats-controller`](https://github.com/kyma-project/kyma/blob/master/components/eventing-controller/cmd/eventing-controller-nats/main.go) which lays down the eventing infrastructure in [NATS](https://docs.nats.io/nats-concepts/intro).
- [`controller`](https://github.com/kyma-project/kyma/blob/main/components/eventing-controller/cmd/eventing-controller/main.go) which lays down the eventing infrastructure in Business Event Bus (BEB).
- [`nats-controller`](https://github.com/kyma-project/kyma/blob/main/components/eventing-controller/cmd/eventing-controller-nats/main.go) which lays down the eventing infrastructure in [NATS](https://docs.nats.io/nats-concepts/intro).

## Prerequisites
- Install [ko](https://github.com/google/ko) which is used to build and deploy the controller during local development
Expand Down Expand Up @@ -33,7 +33,7 @@ This component contains controllers for various CustomResourceDefinitions relate
make deploy-eventing-controller-nats-local-dry-run
```

## Usage
## Usage

This section explains how to use the Eventing Controller.

Expand Down Expand Up @@ -106,12 +106,12 @@ Before running the component, execute the following command once to pull softwar
```sh
make test
## To download dependencies only
make resolve-local
make resolve-local
```

### Generate code during local development

> More details on scaffolding code using kubebuilder can be found [here](https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/simplified-scaffolding.md).
> More details on scaffolding code using kubebuilder can be found [here](https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/simplified-scaffolding.md).

- Add new APIs using [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) CLI followed by generating boilerplate code by executing the following script:

Expand Down
4 changes: 2 additions & 2 deletions components/permission-controller/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Permission Controller

## Overview
The Permission Controller listens for new Namespaces and creates a RoleBinding for the users of the specified group to the **kyma-admin** role within these Namespaces. The Controller uses a blacklist mechanism, which defines the Namespaces in which the users of the defined group are not assigned the **kyma-admin** role. When the Controller is deployed in a cluster, it checks all existing Namespaces and assigns the roles accordingly.
The Permission Controller listens for new Namespaces and creates a RoleBinding for the users of the specified group to the **kyma-admin** role within these Namespaces. The Controller uses a blocking mechanism which defines the Namespaces in which the users of the defined group are not assigned the **kyma-admin** role. When the Controller is deployed in a cluster, it checks all existing Namespaces and assigns the roles accordingly.

Click [here](/resources/permission-controller) to access the Helm chart that defines the component's installation.

Expand Down Expand Up @@ -34,5 +34,5 @@ Use the `run` formula to run the controller using local sources:
```bash
make run EXCLUDED_NAMESPACES={EXCLUDED_NAMESPACES} SUBJECT_GROUPS={SUBJECT_GROUPS} STATIC_CONNECTOR={STATIC_CONNECTOR}
```

See [this file](/resources/permission-controller/README.md#configuration) to learn how to use the environment variables.
Loading

0 comments on commit edf5d9d

Please sign in to comment.