update connector section

rikinsk commented 1 month ago

Description 📝

Mainly making the docs more consistent

added getting started sections to connector pages. made the content consistent
update deploy a connector to a more generic "Managing a connector" page

Quick Links 🚀

Assertion Tests 🤖

hasura-bot commented 1 month ago

Hey, @rikinsk :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Sean as your reviewer :tada:

Before Sean looks over the changes, we ask you to take care of a couple of items:

[ ] Make sure you've checked over our PR guide on the wiki. It ensures you've done your due diligence on the basics: spelling, heading casings, etc.
[ ] Sean will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Sean on Slack, and he'll give a docs review :fire:
[ ] Additionally, please check this box to confirm your feature works as expected when using the documentation you've written. This is critical to ensuring our users have the information they need.

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Sean know the level of urgency on Slack :+1:

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The author has done a substantial job improving the organization of content, enhancing the clarity of the headings, and refining the linking system to guide users more effectively. The addition of prerequisites sections provides a better foundation for new users. The change in the naming of the 'GraphQL Connector' and 'OpenAPI Connector' is more consistent with the naming convention used throughout the docs, making it clearer for the reader. The restructuring in the 'Deploy a Data Connector' section makes the deployment steps more actionable and coherent. The fix in 'ConnectorGallery/index.tsx' where the link is updated to '/business-logic/typescript' ensures users are directed to the right page.

✅ Integrated

Overall, these changes have a positive impact on the user experience. The PR diff improves the documentation's organization, making it more navigable and user-friendly. The consistency in heading formatting across different connector pages creates a cohesive experience, and the more detailed getting started and prerequisites sections ensure that users have all necessary information before diving into the connectors' specifics. Navigation between different sections seems more intuitive, and the renaming of files results in more predictable URLs. Moreover, the inclusion of targeted info boxes for prerequisites across the board reinforces a clear understanding before the user progresses. This is a sound enhancement of the documentation's usability.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying v3-docs with Cloudflare Pages

Latest commit:	`a2d08d3`
Status:	✅ Deploy successful!
Preview URL:	https://01d51d47.v3-docs-eny.pages.dev
Branch Preview URL:	https://rikinsk-update-connectors.v3-docs-eny.pages.dev

View logs

hasura / ddn-docs