Skip to content
This repository has been archived by the owner on Mar 12, 2024. It is now read-only.

Remove cli generated reference #70

Closed
gianarb opened this issue Feb 2, 2021 · 7 comments · Fixed by #81
Closed

Remove cli generated reference #70

gianarb opened this issue Feb 2, 2021 · 7 comments · Fixed by #81

Comments

@gianarb
Copy link
Contributor

gianarb commented Feb 2, 2021

We are deeply re-shaping the CLI right now

tinkerbell/tink#405
tinkerbell/tink#425
tinkerbell/tink#426

And the fact that we do not have a good way to automatically keep this section
up to date with a particular version of tinkebell/tink makes the maintenance not
that fun

@gianarb
Copy link
Contributor Author

gianarb commented Feb 2, 2021

any thought about it @DailyAlice ? Should we remove it or not? Personally I never look at this kind of documentation, I download the CLI and I use --help :D

@thebsdbox
Copy link
Contributor

You mean remove things like https://docs.tinkerbell.org/cli-reference/hardware/ ?

I agree that it is going to be hard as documentation to maintain... and I don't know what we can do to make that easier. It seems like good documentation that it would be a shame to lose though :-(

@gianarb
Copy link
Contributor Author

gianarb commented Feb 2, 2021

Well, you don't use it, you have the same, but up to date via tink --help :) we can mention that in the tink-cli document

@mmlb
Copy link
Contributor

mmlb commented Feb 2, 2021

👍 to have equivalent or better docs in tink --help (I'd love a man page)

@gianarb
Copy link
Contributor Author

gianarb commented Feb 2, 2021 via email

@DailyAlice
Copy link
Contributor

I'm good with having better tink --help in favor of a CLI Reference in docs. And, if after the changes, we see a need for something closer to these docs, we can always make new ones.

@DailyAlice
Copy link
Contributor

I started to work on removal on a branch - https://github.com/DailyAlice/tinkerbell-docs/tree/cli-ref-removal

Think I might just add a line about using tink --help in the Tink CLI doc, and maybe also expand on getting the Tink CLI up and running with tink-server.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants