c8y-docs icon indicating copy to clipboard operation
c8y-docs copied to clipboard

CIE-5505 - Having DataHub Edge doc in a single place

Open rthrippleton opened this issue 1 month ago • 1 comments

Somebody complained (reasonably) that the documentation for DataHub on Edge was slightly fragmented, and would sometimes send you on a link wild goose chase between the DataHub and Edge sections of the doc.

I've transplanted everything into the Edge section of the doc. I think this makes more sense now that Edge is just a Kubernetes-based mini-cloud, and DataHub is "just" another component (with some caveats).

For the same reasons, I've removed a bunch of the kubernetes diagnostic content, because Edge health checks all of its components, and aggregates all of its logs.

rthrippleton avatar Nov 24 '25 20:11 rthrippleton

A general remark for which i did not find the appropriate location: https://cumulocity-iot-c8y-docs-build-pr-3944.surge.sh/edge-kubernetes/installing-edge-on-k8/

It would be good if this page contained a section at the end "Installing DataHub" that linked to the separate DataHub page.

hame-c8y avatar Nov 25 '25 08:11 hame-c8y

@rthrippleton Did you check for any links throughout the documentation targeting the deleted files? Deleting files makes URLs unavailable and might break links.

BeateRixen avatar Dec 01 '25 09:12 BeateRixen

@rthrippleton Did you check for any links throughout the documentation targeting the deleted files? Deleting files makes URLs unavailable and might break links.

I can check manually :-(. Is there any way we can run the automated link check over this PR to save time?

rthrippleton avatar Dec 01 '25 09:12 rthrippleton

@rthrippleton Did you check for any links throughout the documentation targeting the deleted files? Deleting files makes URLs unavailable and might break links.

I can check manually :-(. Is there any way we can run the automated link check over this PR to save time?

No, this is not yet possible. Does this help? These are my findings: image

BeateRixen avatar Dec 01 '25 10:12 BeateRixen

@rthrippleton Did you check for any links throughout the documentation targeting the deleted files? Deleting files makes URLs unavailable and might break links.

I can check manually :-(. Is there any way we can run the automated link check over this PR to save time?

No, this is not yet possible. Does this help? These are my findings: image

OK, I think I've nailed all the relevant broken links. How's it looking now?

rthrippleton avatar Dec 01 '25 10:12 rthrippleton

@rthrippleton Did you check for any links throughout the documentation targeting the deleted files? Deleting files makes URLs unavailable and might break links.

I can check manually :-(. Is there any way we can run the automated link check over this PR to save time?

No, this is not yet possible. Does this help? These are my findings: image

OK, I think I've nailed all the relevant broken links. How's it looking now?

How about the change log?

BeateRixen avatar Dec 02 '25 08:12 BeateRixen

@rthrippleton Did you check for any links throughout the documentation targeting the deleted files? Deleting files makes URLs unavailable and might break links.

I can check manually :-(. Is there any way we can run the automated link check over this PR to save time?

No, this is not yet possible. Does this help? These are my findings: image

OK, I think I've nailed all the relevant broken links. How's it looking now?

How about the change log?

All done now, I just forgot to git push yesterday!

rthrippleton avatar Dec 02 '25 09:12 rthrippleton