hasura / ddn-docs

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

Update Getting Started Collaboration #657

Closed seanparkross closed 4 weeks ago

seanparkross commented 4 weeks ago

Description 📝

Update Getting Started Collaboration with information from here.

Quick Links 🚀

Onboard Teams

Assertion Tests 🤖

Updates Getting Started Collaboration with new workflow

hasura-bot commented 4 weeks ago

Redirects 🔀

Hey, @robertjdominguez & @seanparkross — the following redirects will be needed for deployment:

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/collaborate/comment/
location = /docs/3.0/getting-started/collaborate/comment/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
hasura-bot commented 4 weeks ago

DX: Assertion Testing

✅ Diff

The documentation changes in the PR provide a clear, step-by-step guide for both supergraph admins and subgraph developers, making the onboarding process for collaborators easier to understand. The restructuring of sections now accurately reflects the distinct roles and workflows of different user groups, enhancing the usability specifically for the targeted user actions.

✅ Integrated

The updates integrate well with the entire set of changed files and improve the overarching usability of the documentation. The refocused headers and streamlined steps make the process more approachable for newcomers without overwhelming details. Cross-references to related documentation are maintained, ensuring that users can still access detailed information when needed. The changes respect the existing format and style conventions, ensuring a seamless user experience.

hasura-bot commented 4 weeks ago

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

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4e13386
Status: ✅  Deploy successful!
Preview URL: https://2d6c4a7a.v3-docs-eny.pages.dev
Branch Preview URL: https://sean-update-quickstart-colla.v3-docs-eny.pages.dev

View logs