Skip to content

README for runtime package#125

Merged
hiddeco merged 20 commits intomainfrom
runtime-readme
Jul 12, 2021
Merged

README for runtime package#125
hiddeco merged 20 commits intomainfrom
runtime-readme

Conversation

@hiddeco
Copy link
Copy Markdown
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 added 3 commits July 12, 2021 11:20
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
hiddeco added 2 commits July 12, 2021 11:29
Signed-off-by: Hidde Beydals <hello@hidde.co>
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
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 added 2 commits July 12, 2021 12:58
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
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 added 3 commits July 12, 2021 14:17
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
hiddeco added 2 commits July 12, 2021 15:15
Signed-off-by: Hidde Beydals <hello@hidde.co>
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 added 2 commits July 12, 2021 15:44
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco marked this pull request as ready for review July 12, 2021 13:57
hiddeco added 2 commits July 12, 2021 16:22
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco requested a review from squaremo July 12, 2021 15:07
Copy link
Copy Markdown
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! 🚀

Copy link
Copy Markdown
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.

Comment thread 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
Copy Markdown
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
Copy Markdown
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.

Comment thread runtime/README.md Outdated
Comment thread runtime/README.md Outdated
Comment thread runtime/README.md Outdated
Signed-off-by: Hidde Beydals <hello@hidde.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation related issues and pull requests area/runtime Controller runtime related issues and pull requests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document abstract outline of package in fluxcd/pkg/runtime directory

3 participants