hasura / ddn-docs

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

Rejig and Enhance Project Configuration Section #616

Closed seanparkross closed 6 days ago

seanparkross commented 1 month ago

Description 📝

WIP WIP WIPWIPW WIPWWIWPWIWPWIWPIWWIIIIPPP :)

Quick Links 🚀

Assertion Tests 🤖

hasura-bot commented 1 month ago

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:

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 renaming from 'Supergraph Builds' to 'Builds' simplifies the terminology and is still clear within the context. The additional section 'Subgraph Builds' in builds.mdx implies incremental functionality in the build system, which is a positive addition. The removal of the collaborators.mdx.wip file indicates potential streamlining of project roles management, possibly integrating this information elsewhere more effectively. The addition of the data-connectors.mdx introduces a needed explanation for data connectors, and the choice of titles and structure appears consistent with the overall style.

❌ Integrated

While changes to individual files such as builds.mdx and the addition of data-connectors.mdx are useful, the overall integration appears inconsistent. The deletion of 'collaborators.mdx.wip' without a clear indication of where its contents have been relocated or how this functionality is now covered might result in incomplete documentation. Similarly, the deletion of 'deployment.mdx.wip' and 'migrations.mdx.wip' could leave gaps in the documentation if not addressed elsewhere. The renaming and additions in 'projects.mdx' and 'subgraphs.mdx' should be cross-referenced to ensure the correct mapping of concepts across all documents. It's crucial to maintain a cohesive narrative, and the current diff does not fully show how these deletions and additions work harmoniously as part of the entire documentation set.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5066e14
Status: ✅  Deploy successful!
Preview URL: https://95ac814c.v3-docs-eny.pages.dev
Branch Preview URL: https://sean-restructure-project-con.v3-docs-eny.pages.dev

View logs

hasura-bot commented 1 month ago

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/graphql-api/queries/filters/performance-relationship-comparisons/
location = /docs/3.0/graphql-api/queries/filters/performance-relationship-comparisons/ {
    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/project-configuration/collaborators/.wip
location = /docs/3.0/project-configuration/collaborators/.wip {
    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/project-configuration/deployment/.wip
location = /docs/3.0/project-configuration/deployment/.wip {
    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/project-configuration/migrations/.wip
location = /docs/3.0/project-configuration/migrations/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}