Skip to content

Commit 0c46569

Browse files
doc: update places to direct the users to check the samples in /testdata/ (#3995)
1 parent 7bda41c commit 0c46569

File tree

3 files changed

+5
-32
lines changed

3 files changed

+5
-32
lines changed

website/content/en/docs/building-operators/ansible/reference/retroactively-owned-resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ resource is a cluster level resource.
6464
* operator-sdk/primary-resource: {metadata.namespace}/{metadata.name}
6565
* operator-sdk/primary-resource-type: {kind}.{group}
6666

67-
**NOTE**: The {group} can be found by splitting the `apiVersion`
67+
**NOTE**: The `{group}` can be found by splitting the `apiVersion`
6868
metadata of the CR, into `group` and `version`. As an example,
69-
[this apiVersion field](https://github.com/operator-framework/operator-sdk-samples/blob/938fd148ba106ca9811925e4956d6bb70c36b29d/ansible/memcached-operator/config/samples/cache_v1alpha1_memcached.yaml#L1)
69+
`apiVersion: cache.example.com/v1alpha1` in the `config/samples` directory
7070
gives us the group `cache.example.com`.
7171

7272
**Example Annotation:**

website/content/en/docs/contribution-guidelines/releasing.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -362,34 +362,7 @@ See [this section](#locking-down-branches) for steps to do so.
362362

363363
---
364364

365-
You've now fully released a new version of the Operator SDK. Good work! Make sure to follow the post-release steps below.
366-
367-
### (Post-release) Updating the operator-sdk-samples repo
368-
369-
Many releases change SDK API's and conventions, which are not reflected in the [operator-sdk-samples repo][sdk-samples-repo]. The samples repo should be updated and versioned after each SDK major/minor release with the same tag, ex. `v1.3.0`, so users can refer to the correct operator code for that release.
370-
371-
The release process for the samples repo is simple:
372-
373-
1. Make changes to all relevant operators (at least those referenced by SDK docs) based on API changes for the new SDK release.
374-
1. Ensure the operators build and run as expected (see each operator's docs).
375-
1. Once all API changes are in `master`, create a release tag locally:
376-
```sh
377-
$ git checkout master && git pull
378-
$ export VER="v1.3.0"
379-
$ git tag --sign --message "Operator SDK Samples $VER" "$VER"
380-
```
381-
1. Push the tag to the remote, assuming `upstream` is the name of the upstream remote:
382-
```sh
383-
$ git push upstream $VER
384-
```
385-
386-
### (Post-release) Updating the release notes
387-
388-
Add the following line to the top of the GitHub release notes for `v1.3.0`:
389-
390-
```md
391-
**NOTE:** ensure the `v1.3.0` tag is referenced when referring to sample code in the [SDK Operator samples repo](https://github.com/operator-framework/operator-sdk-samples/tree/v1.3.0) for this release. Links in SDK documentation are currently set to the samples repo `master` branch.
392-
```
365+
You've now fully released a new version of the Operator SDK. Good work!
393366

394367
[install-guide]: /docs/installation/install-operator-sdk
395368
[doc-maintainers]: https://github.com/operator-framework/operator-sdk/blob/master/MAINTAINERS

website/content/en/docs/overview/_overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Find more details about the various levels and the feature requirements for them
5858

5959
## Samples
6060

61-
To explore any operator samples built using the operator-sdk, see the [operator-sdk-samples][samples].
61+
To explore any operator samples built using the operator-sdk, see the samples in [operator-sdk/testdata/][testdata_samples].
6262

6363
## FAQ
6464

@@ -93,5 +93,5 @@ Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file f
9393
[of-home]: https://github.com/operator-framework
9494
[operator_link]: https://coreos.com/operators/
9595
[proposals_docs]: https://github.com/operator-framework/operator-sdk/tree/master/proposals
96-
[samples]: https://github.com/operator-framework/operator-sdk-samples
96+
[testdata_samples]: https://github.com/operator-framework/operator-sdk/tree/master/testdata
9797
[sdk_cli_ref]: /docs/cli/

0 commit comments

Comments
 (0)