hazelcast / hz-docs

Source content for the Hazelcast Platform documentation
10 stars 92 forks source link

Use `latest` documentation version link #1170

Closed JackPGreen closed 1 week ago

netlify[bot] commented 2 weeks ago

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
Latest commit f82c6f5bc00c4dcf052003ab3800cf5d260a0af4
Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/66979a9272aaad0008b28406
Deploy Preview https://deploy-preview-1170--hardcore-allen-f5257d.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

JackPGreen commented 1 week ago

LGTM but suggested removing the hide-nav links

Thanks but I'm not sure I understand the difference?

I've also realised that I've linked to the documentation using a "regular" link to the latest docs - but as were in the documentation it probably should've been versioned (i.e. 5.3's docs should probably link to the 5.3 client page).

I think it'd have been better if I'd used the proper adoc linking syntax instead - do you know what that'd be, please?

oliverhowell commented 1 week ago

I think it'd have been better if I'd used the proper adoc linking syntax instead - do you know what that'd be, please?

You mean like this?

xref:{page-latest-supported-mc}@management-center:getting-started:overview.adoc[Management Center docs]

(from: https://github.com/hazelcast/hz-docs/blob/main/docs/modules/ROOT/pages/management-center.adoc)

JackPGreen commented 1 week ago

I think it'd have been better if I'd used the proper adoc linking syntax instead - do you know what that'd be, please?

You mean like this?

xref:{page-latest-supported-mc}@management-center:getting-started:overview.adoc[Management Center docs]

(from: https://github.com/hazelcast/hz-docs/blob/main/docs/modules/ROOT/pages/management-center.adoc)

Thanks, but I think it's a non-issue now. It was only the Java client docs that linked to another page within the same repo (hz-docs) but via the external URL.