Outdated and bad links for examples

Question

Outdated and bad links for examples

vladimirvivien opened this issue 6 years ago · 7 comments

The example page should be redone to point to new location of hostpath and hostpath doc https://github.com/kubernetes-csi/csi-driver-host-path/blob/master/README.md.
The link to Hostpath driver here is not working https://kubernetes-csi.github.io/docs/deploying.html

Answer 1 · 2019-03-07T10:29:01.000Z

@okartau intents to work on that.

Answer 2 · 2019-03-07T10:31:35.000Z

My suggestion is that most of the text in the example page gets replaced with a short description that kubernetes-csi uses the hostpath driver as example, then link to the csi-driver-host-path README.md for details.

That README.md then has to cover deploying the driver with the deploy script and then can copy most of the usage examples from the current example page.

Answer 3 · 2019-03-07T15:39:04.000Z

liveness-probe is not covered by hostpath deployment, so this part remains documented here?

Answer 4 · 2019-03-07T15:47:33.000Z

and then can copy most of the usage examples from the current example page.

with "and then can copy" part you mean that we repeat examples from this page in hostpath, or we move them, or we link to them?

Answer 5 · 2019-03-07T16:10:23.000Z

We should add liveness probe to hostpath so we can get e2e test coverage

Answer 6 · 2019-03-07T20:13:06.000Z

I created a 1st draft PR, simply deleted duplicate part.
Here is some snapshotter material which is not on hostpath, to be migrated there?
Also, liveness-probe to be added (and doc migrated) on hostpath side, as was already mentioned here.

Answer 7 · 2019-03-08T09:59:18.000Z

with "and then can copy" part you mean that we repeat examples from this page in hostpath, or we move them, or we link to them?

I meant "move". There's no point in having duplicated content.