Skip to content

Commit cc8e1d8

Browse files
[v0.18.x] docs: update contribution guide formatting and a link (#3161)
Co-authored-by: Eric Stroczynski <[email protected]>
1 parent 6fb8011 commit cc8e1d8

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

CONTRIBUTING.MD

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull re
99
## Getting started
1010

1111
- Fork the repository on GitHub
12-
- See the [developer guide](https://sdk.operatorframework.io/docs/contribution-guidelines/developer-guide/) for build instructions
12+
- See the [developer guide][developer-guide] for build instructions
1313

1414
## Reporting bugs and creating issues
1515

16-
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](./doc/dev/reporting_bugs.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug.
16+
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting issues][reporting-issues] before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug.
1717

1818
## Contribution flow
1919

@@ -30,7 +30,7 @@ Thanks for contributing!
3030

3131
### Code style
3232

33-
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
33+
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc][golang-style-doc] for details.
3434

3535
Please follow this style to make operator-sdk easy to review, maintain and develop.
3636

@@ -66,4 +66,7 @@ If the contribution changes the existing APIs or user interface it must include
6666

6767

6868
[operator_framework]: https://groups.google.com/forum/#!forum/operator-framework
69+
[developer-guide]: https://sdk.operatorframework.io/docs/contribution-guidelines/developer-guide/
70+
[reporting-issues]: https://sdk.operatorframework.io/docs/contribution-guidelines/reporting-issues/
71+
[golang-style-doc]: https://github.com/golang/go/wiki/CodeReviewComments
6972
[changelog]: https://github.com/operator-framework/operator-sdk/blob/master/CHANGELOG.md

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ As the Operator SDK interacts directly with the Kubernetes API, certain API feat
2727

2828
Release binaries will be built for the `x86_64` architecture for MacOS Darwin platform and for the following GNU Linux architectures: `x86_64`, `ppc64le`, `s390x`.
2929

30-
Base images for ansible-operator, helm-operator, and scorecard-proxy will be built for the following GNU Linux architectures: `x86_64`, `ppc64le`, `s390x`.
30+
Base images for ansible-operator, helm-operator, scorecard-proxy, and scorecard-test will be built for the following GNU Linux architectures: `x86_64`, `ppc64le`, `s390x`.
3131

3232
Support for the Windows platform is not on the roadmap at this time.
3333

@@ -49,7 +49,7 @@ $ git config [--global] user.email "$GPG_EMAIL"
4949
```
5050

5151
Also, make sure that you setup the git gpg config as follows.
52-
```bash
52+
```console
5353
$ cat ~/.gnupg/gpg.conf
5454
default-key $GPG_KEY_ID
5555
```
@@ -60,10 +60,10 @@ default-key $GPG_KEY_ID
6060
```
6161
export GPG_TTY=`tty`
6262
```
63-
- Restart your Terminal or source your ~/.*rc file
63+
- Restart your Terminal or source your ~/.\*rc file
6464
- Then, make sure git uses gpg2 and not gpg
6565
```bash
66-
$ git config --global gpg.program gpg2
66+
$ git config --global gpg.program gpg2
6767
```
6868
- To make sure gpg2 itself is working
6969
```bash
@@ -90,7 +90,7 @@ The GitHub [`Releases` tab][release-page] in the operator-sdk repo is where all
9090

9191
1. Go to the SDK [`Releases` tab][release-page] and click the `Draft a new release` button in the top right corner.
9292
1. Select the tag version `v1.3.0`, and set the title to `v1.3.0`.
93-
1. Copy and paste any `CHANGELOG.md` under the `v1.3.0` header that have any notes into the description form (see [below](#release-notes)).
93+
1. Copy and paste `CHANGELOG.md` updates under the `v1.3.0` header into the description form (see [below](#release-notes)).
9494
1. Attach all binaries and `.asc` signature files to the release by dragging and dropping them.
9595
1. Click the `Publish release` button.
9696

@@ -154,8 +154,8 @@ $ git verify-tag --verbose "$TAG_NAME"
154154

155155
If you do not have the mantainers public key on your machine, you will get an error message similiar to this:
156156

157-
```sh
158-
git verify-tag --verbose "$TAG_NAME"
157+
```console
158+
$ git verify-tag --verbose "$TAG_NAME"
159159
object 61e0c23e9d2e217f8d95ac104a8f2545c102b5c3
160160
type commit
161161
tag v0.6.0
@@ -230,7 +230,7 @@ Commit the following changes:
230230
- `internal/scaffold/go_mod.go`, change the `require` line version for `github.com/operator-framework/operator-sdk` from `master` to `v1.3.0`.
231231
- `internal/scaffold/helm/go_mod.go`: same as for `internal/scaffold/go_mod.go`.
232232
- `internal/scaffold/ansible/go_mod.go`: same as for `internal/scaffold/go_mod.go`.
233-
- `doc/user/install-operator-sdk.md`: update the linux and macOS URLs to point to the new release URLs.
233+
- `website/content/en/docs/install-operator-sdk.md`: update the linux and macOS URLs to point to the new release URLs.
234234
- `CHANGELOG.md`: commit changes (updated by changelog generation).
235235
- `website/content/en/docs/migration/v1.3.0.md`: commit changes (created by changelog generation).
236236
- `changelog/fragments/*`: commit deleted fragment files (deleted by changelog generation).
@@ -311,18 +311,18 @@ Now that the branch exists, you need to make the post-release PR for the new rel
311311
We support installing via [Homebrew][homebrew], so we need to update the operator-sdk [Homebrew formula][homebrew-formula] once the release is cut. Follow the instructions below, or for more detailed ones on the Homebrew contribution [README][homebrew-readme], to open a PR against the [repository][homebrew-repo].
312312

313313

314-
```
315-
docker run -t -d linuxbrew/brew:latest
316-
docker exec -it <CONTAINER_ID> /bin/bash`
314+
```sh
315+
$ docker run -t -d linuxbrew/brew:latest --name homebrew
316+
$ docker exec --rm -it homebrew /bin/bash
317317
# Run the following commands in the container.
318-
git config --global github.name <GITHUB-USERNAME>
319-
git config --global github.token <GITHUB-TOKEN>
318+
$ git config --global github.name <GITHUB-USERNAME>
319+
$ git config --global github.token <GITHUB-TOKEN>
320320
# Replace the release version of the newly cut release.
321-
OPERATORSDKURL=https://github.com/operator-framework/operator-sdk/archive/<RELEASE-VERSION>.tar.gz
322-
curl $OPERATORSDKURL -o operator-sdk
321+
$ export OPERATORSDKURL=https://github.com/operator-framework/operator-sdk/archive/<RELEASE-VERSION>.tar.gz
322+
$ curl -L $OPERATORSDKURL -o operator-sdk
323323
# Calculate the SHA256
324-
OPERATORSUM="$(sha256sum operator-sdk | cut -d ' ' -f 1)"
325-
brew bump-formula-pr --strict --url=$OPERATORSDKURL --sha256=$OPERATORSUM operator-sdk
324+
$ export OPERATORSUM="$(sha256sum operator-sdk | cut -d ' ' -f 1)"
325+
$ brew bump-formula-pr --strict --url=$OPERATORSDKURL --sha256=$OPERATORSUM operator-sdk
326326
```
327327

328328
Note: If there were any changes made to the CLI commands, make sure to look at the existing tests, in case they need updating.
@@ -340,7 +340,7 @@ The release process for the samples repo is simple:
340340
1. Once all API changes are in `master`, create a release tag locally:
341341
```console
342342
$ git checkout master && git pull
343-
$ VER="v1.3.0"
343+
$ export VER="v1.3.0"
344344
$ git tag --sign --message "Operator SDK Samples $VER" "$VER"
345345
$ git push --tags
346346
```

0 commit comments

Comments
 (0)