Skip to content
This repository has been archived by the owner on Jan 17, 2025. It is now read-only.

Commit

Permalink
Change excluding terms into inclusive alternatives (#175)
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolina Zydek authored Apr 6, 2021
1 parent c6b964b commit 704779f
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 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.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## 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 guidelines, see other sections of this document.

## Naming guidelines

In addition to the general [naming guidelines](https://github.com/kyma-project/community/blob/master/guidelines/technical-guidelines/01-naming.md), the `examples` repository has these conventions to follow:
In addition to the general [naming guidelines](https://github.com/kyma-project/community/blob/main/guidelines/technical-guidelines/01-naming.md), the `examples` repository has these conventions to follow:

- Folders:
- All folder names are lowercase and connected with a dash (`-`) when they are comprised of two or more words. For example, `http-db-service`.
Expand All @@ -23,7 +23,7 @@ In addition to the general [naming guidelines](https://github.com/kyma-project/c

This file type contains information about what an example illustrates, and the instructions on how to run it. Each example in this repository requires a `README.md` document.

To create new `README.md` documents for new examples, use the [template](https://github.com/kyma-project/community/blob/master/guidelines/templates/resources/example_README.md) provided.
To create new `README.md` documents for new examples, use the [template](https://github.com/kyma-project/community/blob/main/guidelines/templates/resources/example_README.md) provided.
Do not change the names or the order of the main sections in the `README.md` documents. However, you can create subsections to adjust each `README.md` document to the example's specific requirements. See the example of a [README.md](http-db-service/README.md) document.

Find all `README.md` documents listed in the **List of examples** section in the main [README.md](README.md) document. When you create a new `README.md` document, add a new entry to the **List of examples** table. Follow these steps:
Expand All @@ -37,7 +37,7 @@ Find all `README.md` documents listed in the **List of examples** section in the

## Contribution rules

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

In addition to these general rules, every contributor to the `examples` repository must follow the rules described in the subsections.

Expand Down Expand Up @@ -72,7 +72,7 @@ For all examples, the main `README.md` documents include the build scripts and t

All examples are deployable in the cloud. Follow these rules to achieve this and to keep the complexity to a minimum:

- All examples have only one `Dockerfile` which generates a single Docker image. The Docker image follows the Docker image [naming conventions](https://github.com/kyma-project/community/blob/master/guidelines/technical-guidelines/01-naming.md).
- All examples have only one `Dockerfile` which generates a single Docker image. The Docker image follows the Docker image [naming conventions](https://github.com/kyma-project/community/blob/main/guidelines/technical-guidelines/01-naming.md).
- Only example images that are completely built are accessible in the registry, so the examples can be deployed to the cloud without the user having to build and push a new image.
- All `README.md` documents in the examples provide the scripts to build and deploy images locally, and the instructions on how to run them.
- Provide Deployment configurations and descriptors in a user-friendly format such as a `yaml` file, and never in bundled formats such as Helm charts, unless the example itself illustrates the usage of bundled formats.
Expand All @@ -82,7 +82,7 @@ All examples are deployable in the cloud. Follow these rules to achieve this and

### Continuous integration

A CI/CD configuration file accompanies each example to ensure its validity as part of the automation pipeline.
A CI/CD configuration file accompanies each example to ensure its validity as part of the automation pipeline.

### Acceptance tests

Expand Down
2 changes: 1 addition & 1 deletion http-db-service/config/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
type Service struct {
Port string `envconfig:"serviceport,default=8017" json:"Port"`
// DbType set to 'mssql' will start the service using an MsSql datbase
// and it will require extra configuration. See https://github.com/kyma-project/examples/blob/master/http-db-service/internal/mssqldb/config.go
// and it will require extra configuration. See https://github.com/kyma-project/examples/blob/main/http-db-service/internal/mssqldb/config.go
DbType string `envconfig:"dbtype,default=memory" json:"DBType"` // [memory | mssql]
}

Expand Down
2 changes: 1 addition & 1 deletion http-db-service/internal/repository/db.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type dbQuerier interface {

// NewOrderRepositoryDb is used to instantiate and return the DB implementation of the OrderRepository.
// The connection to the database is created by initiating the configuration defined
// in https://github.com/kyma-project/examples/blob/master/http-db-service/internal/mssqldb/config.go
// in https://github.com/kyma-project/examples/blob/main/http-db-service/internal/mssqldb/config.go
func NewOrderRepositoryDb() (OrderRepository, error) {
var (
dbCfg dbPkg.Config
Expand Down
2 changes: 1 addition & 1 deletion orders-service/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ COPY ./go.sum .
RUN go mod download

#
# copy files whitelisted in .dockerignore
# copy files allowed in .dockerignore
#
COPY . ${BASE_APP_DIR}/

Expand Down
4 changes: 2 additions & 2 deletions rafter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ By default, [MinIO](https://min.io/) stores all resources on a cluster, but it a
Example:

```bash
export GH_WEBPAGE_URL=https://github.com/kyma-project/examples/archive/master.zip
export GH_WEBPAGE_URL=https://github.com/kyma-project/examples/archive/main.zip
```

2. Apply a Bucket custom resource (CR):
Expand Down Expand Up @@ -72,7 +72,7 @@ By default, [MinIO](https://min.io/) stores all resources on a cluster, but it a
5. Export and merge the values of the **baseUrl** field and the path to the `index.html` file from the Asset CR, and then open it in a default web browser:
```bash
open $(kubectl get assets.rafter.kyma-project.io webpage -o jsonpath='{.status.assetRef.baseUrl}{"/examples-master/rafter/webpage/index.html"}')
open $(kubectl get assets.rafter.kyma-project.io webpage -o jsonpath='{.status.assetRef.baseUrl}{"/examples-main/rafter/webpage/index.html"}')
```
### Cleanup
Expand Down

0 comments on commit 704779f

Please sign in to comment.