Skip to content

Updates developer documentation to give examples of using make#1023

Merged
jetstack-bot merged 5 commits intocert-manager:masterfrom
SgtCoDFish:makedocs
Jun 29, 2022
Merged

Updates developer documentation to give examples of using make#1023
jetstack-bot merged 5 commits intocert-manager:masterfrom
SgtCoDFish:makedocs

Conversation

@SgtCoDFish
Copy link
Copy Markdown
Member

@SgtCoDFish SgtCoDFish commented Jun 28, 2022

This replaces a lot of older documentation which referenced bazel, most of which will no longer work. A lot of the docs were incorrect even before we started making the switch to make.

Sorry that this is a large PR; I ended up changing more than I expected because so much of the language was out of date, broken or just wrong. Our DCO signoff page for example still asked that copyright notices mention Jetstack, even though the notices were updated a long time ago!

Important: This PR is smaller than it looks! Since all the changes are duplicated in both docs and next-docs, the lines changed looks twice as big as it actually is!

includes rewording and clarifications on CRD documentation and API
compatibility guarantees

Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
Mostly this is just rewording to make things read better, fixing
typos and adding clarifications

Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
I'd missed this in code review

Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
@jetstack-bot jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 28, 2022
@netlify
Copy link
Copy Markdown

netlify bot commented Jun 28, 2022

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 81cd46c
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/62bc36a1061eb00008385252
😎 Deploy Preview https://deploy-preview-1023--cert-manager-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

# istioctl install --set profile=openshift -f istio-install-config.yaml
```

You will be prompted for input to confirm your choice of Istio profile:
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: This is just #1022 but copied into next-docs - I didn't spot it when I reviewed that PR, so I'm fixing it here 😁

Copy link
Copy Markdown
Contributor

@irbekrm irbekrm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @SgtCoDFish !

I've read through the doc and generally this looks good to me- I believe that this is a part that will be changed and improved as we go, so no need to try to get this perfect first time round.

I've added a couple nits, but generally happy to lgtm

Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
@SgtCoDFish SgtCoDFish requested a review from irbekrm June 29, 2022 11:25
Copy link
Copy Markdown
Contributor

@irbekrm irbekrm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the extra info for what go version is used @SgtCoDFish!

I think this is good to be merged now- folks will benefit from knowing/being able to use make

/lgtm


To return to using your system version of go, run: `make unvendor-go`.

To check which version of Go is _currently_ being used, run: `make which-go`, which prints the version number of Go and the path to the Go binary.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thanks!

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 29, 2022
@jetstack-bot jetstack-bot merged commit d561732 into cert-manager:master Jun 29, 2022
@jetstack-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irbekrm, SgtCoDFish

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants