search

hazelcast / hz-docs

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

Create Documentation for Enterprise Rest API [DEX-78] #1097

Closed celenmelike closed 1 month ago

celenmelike commented 2 months ago

New documentation is created for Enterprise REST API.

netlify[bot] commented 2 months ago

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
Latest commit e5baa912756bb29076ce42f62351a31bbbb96216
Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/6647652b0b847d00083ef3d8
Deploy Preview https://deploy-preview-1097--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.

Serdaro commented 2 months ago

@ihsandemir , @celenmelike , @emreyigit

As agreed, in the navigation, new REST API content will come before the existing open source one.

How should we proceed with various sections in which we give examples with REST calls? For example, cluster merges, reload/upload, WAN replication. I was thinking of gathering all the current REST API related content from various parts of Platform docs (example links above) into a single section (basically to https://docs.hazelcast.com/hazelcast/5.4/maintain-cluster/rest-api). But not sure if this is the right approach. WDYT?

ihsandemir commented 2 months ago

@ihsandemir , @celenmelike , @emreyigit

As agreed, in the navigation, new REST API content will come before the existing open source one.

How should we proceed with various sections in which we give examples with REST calls? For example, cluster merges, reload/upload, WAN replication. I was thinking of gathering all the current REST API related content from various parts of Platform docs (example links above) into a single section (basically to https://docs.hazelcast.com/hazelcast/5.4/maintain-cluster/rest-api). But not sure if this is the right approach. WDYT?

@Serdaro See my above comment. I suggested that we do not list all the APIs but redirect users to swagger documentation for reference. what do you think?

Serdaro commented 2 months ago

@ihsandemir , agreed. Then I am suggesting to update the "deprecation notice" text in the relevant sections like https://docs.hazelcast.com/hazelcast/5.4/wan/advanced-features#synchronizing-wan-target-cluster, so that the users are suggested to check the swagger docs. Makes sense?

ihsandemir commented 2 months ago

@ihsandemir , agreed. Then I am suggesting to update the "deprecation notice" text in the relevant sections like https://docs.hazelcast.com/hazelcast/5.4/wan/advanced-features#synchronizing-wan-target-cluster, so that the users are suggested to check the swagger docs. Makes sense?

Yes, you can do that but let them also look at the new REST section in coordination with the API documentation. Hence, if possible add both links.

Serdaro commented 2 months ago

@ihsandemir , @celenmelike , trying to set up the environment on my local. Once it is done, I will start the full review.

Serdaro commented 2 months ago

@celenmelike , I think it was decided that we keep the legacy REST API docs (@ihsandemir to confirm). In that case, let's add the enterprise-rest-api.doc to the navigation (so that we can see the content in the deploy preview). You can simply add it in the https://github.com/celenmelike/hz-docs/blob/enterprise-rest-doc/docs/modules/maintain-cluster/partials/nav.adoc file, before the ** xref:maintain-cluster:rest-api.adoc[REST API] line.

Tasks to be done: