Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README for runtime package #125

Merged
merged 20 commits into from
Jul 12, 2021
Merged

README for runtime package #125

merged 20 commits into from
Jul 12, 2021

Conversation

hiddeco
Copy link
Member

@hiddeco hiddeco commented Jul 9, 2021

Fixes #118

@hiddeco hiddeco added area/docs Documentation related issues and pull requests area/runtime Controller runtime related issues and pull requests labels Jul 9, 2021
@hiddeco hiddeco force-pushed the runtime-readme branch 9 times, most recently from 99cdd69 to 5190205 Compare July 12, 2021 08:34
@hiddeco
runtime: outline package and goals in README
1f8510d 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: list supported standards in README
f6e27a9 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document usage in README
bf3b761 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document conditions pacakge in README
4aa5821 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document runtime config opts in README
6cd2168 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime/pprof: expose Endpoints
0039621 
This makes them part of the public API (and thereby makes them
documented) and allows overwrites in case this is ever required.

Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco force-pushed the runtime-readme branch 2 times, most recently from 0dbb9a4 to 78aac43 Compare July 12, 2021 09:35
@hiddeco
runtime: document debugging in README
411b581 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco force-pushed the runtime-readme branch 2 times, most recently from 6063339 to 15f17a1 Compare July 12, 2021 10:05
@hiddeco
runtime: document testing in README
8628d6a 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document safe patching in README
666b976 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document controller helpers in README
e4fb0a9 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco force-pushed the runtime-readme branch 2 times, most recently from 2c9909a to 0b3d042 Compare July 12, 2021 12:17
@hiddeco
runtime: document forward events in README
46ccb11 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document recording metrics in README
063c42d 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: change "usage" order in README
6ee5af3 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document dependency ordering in README
b6d8262 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: note about conditions and meta API pkg
f7a1d07 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco force-pushed the runtime-readme branch 2 times, most recently from 6cc9688 to f7a1d07 Compare July 12, 2021 13:30
@hiddeco
runtime: document errors in README
fbaeeda 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: document predicates in README
5577a1b 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco marked this pull request as ready for review July 12, 2021 13:57
@hiddeco
runtime: list controller-runtime as "standard"
883e09f 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
runtime: link to envtest doc in README
e22885e 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco requested a review from squaremo July 12, 2021 15:07
scottrigby
scottrigby approved these changes Jul 12, 2021
View reviewed changes
Copy link
Member

@scottrigby scottrigby left a comment

Choose a reason for hiding this comment

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

Commented offline.

This reads so incredibly well 👏 🏆

lgtm! 🚀

squaremo
squaremo approved these changes Jul 12, 2021
View reviewed changes
Copy link
Member

@squaremo squaremo left a comment

Choose a reason for hiding this comment

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

<3 to see this quality of docs; thank you Hidde.

runtime/README.md
## Usage

To use the packages in your project, import `github.com/fluxcd/pkg/runtime` using `go get` or your dependency manager
of choice:
Copy link
Member

Choose a reason for hiding this comment

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

Is there any option other than go get (or go get, implicitly, via other go commands)?

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't want to imply that using Go Modules is a strict requirement, using e.g. dep ensure should work perfectly fine as well.

runtime/README.md Outdated Show resolved Hide resolved
runtime/README.md Outdated Show resolved Hide resolved
runtime/README.md Outdated Show resolved Hide resolved
@hiddeco
runtime: address review nits README
4599158 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco merged commit 1e9d464 into main Jul 12, 2021
@hiddeco hiddeco deleted the runtime-readme branch July 12, 2021 16:45
This was referenced Jul 16, 2021
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@squaremo squaremo squaremo approved these changes

@scottrigby scottrigby scottrigby approved these changes

Assignees
No one assigned
Labels
area/docs Documentation related issues and pull requests area/runtime Controller runtime related issues and pull requests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document abstract outline of package in fluxcd/pkg/runtime directory
3 participants
@hiddeco @squaremo @scottrigby