Skip to content

Commit 20ee050

Browse files
Merge pull request #518 from shiftstack/dependants
docs: Give some hope on maturity
2 parents 61bbb52 + 9d277dc commit 20ee050

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,12 @@ ORC is based on [Gophercloud][gophercloud], the OpenStack Go SDK.
1414
[orc]: https://github.com/k-orc/openstack-resource-controller
1515
[gophercloud]: https://github.com/gophercloud/gophercloud
1616

17-
## Disclaimer
17+
## Maturity
1818

19-
This project is in active development, and features, functionality, or APIs may
20-
change frequently. While we strive to make the project stable, you may
21-
encounter bugs, unfinished features, or breaking changes. We encourage you to
22-
contribute, file issues, and help improve the project as we continue to work on
23-
it!
19+
While we currently cover a limited subset of OpenStack resources, we focus on
20+
making existing controllers as correct and predictable as possible. We
21+
encourage you to contribute, file issues, and help improve the project as we
22+
continue to work on it!
2423

2524
ORC versioning follows [semver](https://semver.org/spec/v2.0.0.html): there will be no breaking changes within a major release.
2625

website/docs/index.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,19 @@ ORC is based on [Gophercloud][gophercloud], the OpenStack Go SDK.
1414
[orc]: https://github.com/k-orc/openstack-resource-controller
1515
[gophercloud]: https://github.com/gophercloud/gophercloud
1616

17-
### Disclaimer
17+
### Maturity
1818

19-
This project is in active development, and features, functionality, or APIs may
20-
change frequently. While we strive to make the project stable, you may
21-
encounter bugs, unfinished features, or breaking changes. We encourage you to
22-
contribute, file issues, and help improve the project as we continue to work on
23-
it!
19+
While we currently cover a limited subset of OpenStack resources, we focus on
20+
making existing controllers as correct and predictable as possible.
21+
22+
ORC is deployed and used in production environments and is notably a dependency
23+
of Cluster API's [OpenStack provider][capo].
24+
25+
ORC versioning follows [semver]: there will be no breaking changes within a
26+
major release.
27+
28+
[semver]: https://semver.org/spec/v2.0.0.html
29+
[capo]: https://github.com/kubernetes-sigs/cluster-api-provider-openstack
2430

2531
### How You Can Contribute
2632

0 commit comments

Comments
 (0)