Getting Started > Build Tweaks

[seanparkross]

Description 📝

Updates a few things in Getting Started / Build

Quick Links 🚀

GS Build

Assertion Tests 🤖

Updates a few things in getting started for consistency.

[hasura-bot]

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_clickHouse/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_clickHouse/_01-connect-a-source/ {
    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/build/03-connect-to-data/_databaseDocs/_graphql/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_graphql/_01-connect-a-source/ {
    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/build/03-connect-to-data/_databaseDocs/_mongoDB/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_mongoDB/_01-connect-a-source/ {
    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/build/03-connect-to-data/_databaseDocs/_openAPI/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_openAPI/_01-connect-a-source/ {
    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/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

[hasura-bot]

Hey, @seanparkross :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]

DX: Assertion Testing

✅ Diff

The author has successfully made several changes aimed at improving consistency across the documentation. Updates such as changing 'connector-name' to 'connector-link-name' ensure uniform terminology, which is crucial for user comprehension. The modification to include 'commands or relationships' alongside 'models' adds clarity that these entities can also be added en masse using the same procedure. The line break adjustments in the command blocks also improve readability.

✅ Integrated

Looking at the bigger picture, the changes integrate well with the entire documentation set, maintaining consistency across different database documentation. The tweaks are not only surface-level but also reflect on commands and terminologies, ensuring that users will receive uniform instructions irrespective of the underlying database or data connector. Removing the image thumbnail which might have been outdated or irrelevant helps in decluttering the instructions. However, please confirm if the removal was intentional and whether a replacement is needed to maintain contextual help. Lastly, clarifying the addition of setting a subgraph in context when initializing the connectors enhances the set-up process for new users.

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

Deploying v3-docs with    Cloudflare Pages

Latest commit:	28b50ae
Status:	✅  Deploy successful!
Preview URL:	https://ffe511a4.v3-docs-eny.pages.dev
Branch Preview URL:	https://sean-getting-started-tweaks.v3-docs-eny.pages.dev

View logs