Skip to content

Commit

Permalink
Merge pull request #466 from simonbaird/conforma-rename
Browse files Browse the repository at this point in the history
Mention the new project name in documentation
  • Loading branch information
simonbaird authored Jan 24, 2025
2 parents fa2fc55 + 6db46bc commit 2e0a33e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Enterprise Contract welcomes contributions in many forms. [Pull requests](https://docs.github.com/en/get-started/quickstart/github-glossary#pull-request) are specifically appreciated and the maintainers will make every effort to assist with any issues in the pull request discussion. Feel free to create a pull request even if you are new to the process. If you need more information, see [this article](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) about how creating a pull request.
Conforma (formerly known as Enterprise Contract) welcomes contributions in many forms. [Pull requests](https://docs.github.com/en/get-started/quickstart/github-glossary#pull-request) are specifically appreciated and the maintainers will make every effort to assist with any issues in the pull request discussion. Feel free to create a pull request even if you are new to the process. If you need more information, see [this article](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) about how creating a pull request.

## Code of Conduct

Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Enterprise Contract controller
A Kubernetes controller for Enterprise Contract resources.

A Kubernetes controller that defines a CRD for Conforma (formerly known as Enterprise Contract) resources.

## Description
Currently contains `EnterpriseContractConfiguration` Kubernetes custom resource. See an [example](config/samples/appstudio.redhat.com_v1alpha1_enterprisecontractpolicy.yaml).

> [!NOTE]
> Enterprise Contract is now called Conforma. However, because changing the CRD and controller name would have a large impact, we're not going to rename them at this stage.
## Getting Started
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
Expand Down
11 changes: 10 additions & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
= About Enterprise Contract Policy
= About Conforma Policy

NOTE: Conforma was previously known as "Enterprise Contract". In general you
can consider "Conforma" and "Enterprise Contract" to be synonynous. See
link:/posts/whats-in-a-name/[this article] for more details about the name
change. However, because renaming the CRD and the controller is a large and
significant change that impacts multiple other systems, the controller and the
CRD are going to keep their original names, at least in the short and medium
term. As a consequence this documentation will continue to refer to "Enterprise
Contract" in many places.

The Enterprise Contract Policy defines the configuration for the enforcement of the Enterprise
Contract by specifying the rules needed for a container image to be compliant with an organization's
Expand Down

0 comments on commit 2e0a33e

Please sign in to comment.