Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Document 'fluxctl install' in fluxctl reference #2476

Closed
dholbach opened this issue Sep 25, 2019 · 3 comments · Fixed by #2489
Closed

Document 'fluxctl install' in fluxctl reference #2476

dholbach opened this issue Sep 25, 2019 · 3 comments · Fixed by #2489
Labels
docs Issue or PR relates to documentation UX In pursuit of a delightful user experience

Comments

@dholbach
Copy link
Member

https://docs.fluxcd.io/en/latest/references/fluxctl.html does not explain fluxctl install yet. This was apparently not part of the #2298 PR.
@dholbach dholbach added bug docs Issue or PR relates to documentation blocked-needs-validation Issue is waiting to be validated before we can proceed hacktoberfest UX In pursuit of a delightful user experience and removed blocked-needs-validation Issue is waiting to be validated before we can proceed bug labels Sep 25, 2019
@stefanprodan
Copy link
Member

stefanprodan commented Sep 25, 2019 •
edited
Loading

I would not duplicate the install command in the docs, a link to https://docs.fluxcd.io/en/latest/tutorials/get-started.html#set-up-flux should do.

@dholbach
Copy link
Member Author

In the command listings of fluxctl it's not even listed. I would expect a mention and brief discussion in a reference type document. No duplication though, sure.

@domgoodwin domgoodwin mentioned this issue Oct 1, 2019
Merged
@domgoodwin
Copy link
Contributor

I've opened a PR to address this issue

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
docs Issue or PR relates to documentation UX In pursuit of a delightful user experience
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added install to fluxctl output domgoodwin/flux
3 participants
@dholbach @stefanprodan @domgoodwin