hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

CPS-888: add data plane collaboration docs #661

Closed purugupta99 closed 3 weeks ago

purugupta99 commented 3 weeks ago

Description 📝

This PR adds docs for the private ddn data plane collaboration feature.

Project Link: here

Quick Links 🚀

/deployment/data-plane-collaboration/

NOTE: Not sure which section will these docs go in, feel free to move them to a new/another section.

Assertion Tests 🤖

hasura-bot commented 3 weeks ago

DX: Assertion Testing

✅ Diff

The author has provided a comprehensive guide to the Data Plane Collaboration feature, including steps for inviting, accepting, rejecting, and removing collaborators. The usage of images is helpful for users to understand the process visually. Also, the inclusion of the specific commands needed to create a project within the data plane collaboration context is beneficial.

✅ Integrated

The new file integrates well into the existing set of documentation for private deployments. The sidebar is updated to include the new 'Data Plane Collaboration' page, maintaining the consistency and usability of the documentation structure. The inclusion of this section expands the usefulness of the documentation by giving private DDN users clear instructions on collaborative features, which is a crucial aspect of working in team environments.

hasura-bot commented 3 weeks ago

@purugupta99 Thanks for your PR! I've assigned @Rob to review it.

hasura-bot commented 3 weeks ago

Images automagically compressed by Calibre's image-actions

Compression reduced images by 24.7%, saving 20.61 KB.

Filename Before After Improvement Visual comparison
static/img/deployment/accept_reject_data_plane_invitation.png 22.97 KB 17.00 KB -26.0% View diff
static/img/deployment/invite_data_plane_collaborator.png 40.67 KB 30.64 KB -24.7% View diff
static/img/deployment/remove_data_plane_collaborator.png 19.82 KB 15.20 KB -23.3% View diff

184 images did not require optimisation.

cloudflare-workers-and-pages[bot] commented 3 weeks ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9ba94f9
Status: ✅  Deploy successful!
Preview URL: https://e3f7fe2d.v3-docs-eny.pages.dev
Branch Preview URL: https://puru-add-data-plane-collabor.v3-docs-eny.pages.dev

View logs

linear[bot] commented 3 weeks ago

CPS-888 Add docs for private ddn data plane collaborators

purugupta99 commented 3 weeks ago

Is this only for Hasura-Hosted Private DDN?

Hi @robertjdominguez, thanks for the suggestions, I have applied them. As per the above question, this feature is available for both self and hasura hosted data planes. So shall we move this to the private deployment section?

robertjdominguez commented 3 weeks ago

Is this only for Hasura-Hosted Private DDN?

Hi @robertjdominguez, thanks for the suggestions, I have applied them. As per the above question, this feature is available for both self and hasura hosted data planes. So shall we move this to the private deployment section?

Lol — I figured it was a self-hosted customer 😆

example@hasura.io works just fine 🤙

hasura-bot commented 3 weeks ago

Images automagically compressed by Calibre's image-actions

Compression reduced images by 24.1%, saving 14.44 KB.

Filename Before After Improvement Visual comparison
static/img/deployment/invite_data_plane_collaborator.png 40.42 KB 30.64 KB -24.2% View diff
static/img/deployment/remove_data_plane_collaborator.png 19.48 KB 14.82 KB -23.9% View diff

185 images did not require optimisation.