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.

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

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

Closed
scottrigby opened this issue Jul 7, 2021 · 0 comments · Fixed by #125
Closed

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

scottrigby opened this issue Jul 7, 2021 · 0 comments · Fixed by #125
Labels
area/docs Documentation related issues and pull requests area/runtime Controller runtime related issues and pull requests

Comments

@scottrigby
Copy link
Member

Follow up to #117

This is a top level README in fluxcd/pkg/runtime.

This should be a markdown version in the package as a GitHub landing page, which outlines and glues together the in-depth directory contents, but doesn’t give any advice on how to use them (that will be added separately to the website). To show users code examples, link to inline code examples in the go documentation. The idea is for this to be a lighter version of what we will put on the website, in the context of runtime package only.

Contains:

  • Description (in go doc directory)
  • A more human description of what’s written in the package descriptions
  • Intro
  • List of things that are in there
  • Generic list of subjects (standards, or other things to take into account if you make use of the runtime package or contributing to Flux)
  • When we mention our standards and API conventions, we can link to the packages that help with those standards

/assign @hiddeco

@hiddeco hiddeco self-assigned this Jul 7, 2021
@hiddeco hiddeco added area/docs Documentation related issues and pull requests area/runtime Controller runtime related issues and pull requests labels Jul 8, 2021
@hiddeco hiddeco removed their assignment Jul 12, 2021
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 a pull request may close this issue.

2 participants