update connector deployment and region routing

[rikinsk]

Description

• move region routing to under connectors. (wondering why was it put under graphql-api :thinking:)
• update region routing to latest connector format
• update connector deployment docs
• add more information on connector deployment best practices

Quick Links 🚀

https://rikinsk-move-region-routing.v3-docs-eny.pages.dev/connectors/region-routing

🤖 DX: Assertion Tests

update connector routing configuration based on ConnectorDefinitionV2

[robertjdominguez]

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_clickHouse/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_graphql/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_mongoDB/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_openAPI/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_postgreSQL/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/
location = /docs/3.0/getting-started/deployment/_databaseDocs/_typeScript/_03-deploy-a-connector/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/graphql-api/region-routing/
location = /docs/3.0/graphql-api/region-routing/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

[robertjdominguez]

DX: Assertion Testing

✅ Diff

The documentation PR explicitly outlines the new steps required for initializing a connector, which improves clarity. The addition of the introspection step and the updated guidance around environmental variables provide users with critical information needed to properly configure their connectors. The deletion of the old CONNECTION_URI specification in the env file is congruent with the changes, showing a transition towards a new approach in connector deployment.

✅ Integrated

The documentation updates integrate well with existing content. The new section on Region Routing is comprehensive and beneficial for users needing detailed information on deploying connectors in various regions. By removing the outdated information (e.g., the deletion of graphql-api/region-routing.mdx) and updating references in the getting-started subsections, the updated documentation provides a more streamlined, coherent, and up-to-date user experience. The navigation and interpretation of the docs should improve as a result, matching the usability assertion.

[cloudflare-workers-and-pages[bot]]

Deploying v3-docs with    Cloudflare Pages

Latest commit:	15666b5
Status:	✅  Deploy successful!
Preview URL:	https://b8a9dbcd.v3-docs-eny.pages.dev
Branch Preview URL:	https://rikinsk-move-region-routing.v3-docs-eny.pages.dev

View logs

[seanparkross]

Redirect: Docs redirect for region routing