Finalise restructure

[seanparkross]

Description 📝

Collaboration

• collaboration/service-accounts.mdx => ➡️ file moved to project-configuration/project-management/service-accounts.mdx
• collaboration/best-practices.mdx => ❌ deleted. Develop, Review, Deploy is already covered in other sections.
• collaboration/comment.mdx => ➡️ file moved to project-configuration/project-management/console-collaborator-comments.mdx
• collaboration/federation.mdx => ❌ deleted. Covered in project-configuration/subgraphs/
• Collaboration section => ❌ deleted

Federation

• federation/basics.mdx => ❌ deleted. Information covered in project-configuration/*
• federation/architecture.mdx => ❌ deleted and ➡️ info moved to enhance Glossary and FAQ
• federation/subgraph-prefixing => ➡️ file moved to project-configuration/subgraphs/*
• federation/build-commands => ❌ deleted. Information covered elsewhere
• federation/cross-repo-relationships => ❌ deleted and ➡️ info moved to project-configuration/subgraphs/working-with-multiple-subgraphs.mdx
• federation/independent-subgraph-development => ❌ deleted and ➡️ Information moved to /project-configuration/subgraphs/working-with-multiple-subgraphs.mdx and /project-configuration/subgraphs/working-with-multiple-repositories.mdx
• Federation section => ❌ deleted

Upgrade

• Upgrade section ⬇️ moved down and renamed "Upgrade from v2"

Architecture

• architecture/private/ byoc.mdx + dedicated.mdx + self-hosted.mdx => ➡️ files moved to private-ddn/architecture/*
• architecture/topology.mdx +overview.mdx => ❌ deleted and ➡️ info moved to /reference/ddn-topology-architecture.mdx
• Architecture section => ❌ deleted

Quick Links 🚀

Many. See above.

[hasura-bot]

Redirects 🔀

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

# TEST ME: https://stage.hasura.io/docs/3.0/architecture/_category_.json
location = /docs/3.0/architecture/_category_.json {
    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/architecture/overview/
location = /docs/3.0/architecture/overview/ {
    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/architecture/private/_category_.json
location = /docs/3.0/architecture/private/_category_.json {
    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/collaboration/_category_.json
location = /docs/3.0/collaboration/_category_.json {
    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/collaboration/best-practices/
location = /docs/3.0/collaboration/best-practices/ {
    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/collaboration/federation/
location = /docs/3.0/collaboration/federation/ {
    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/collaboration/index/
location = /docs/3.0/collaboration/index/ {
    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/collaboration/overview/
location = /docs/3.0/collaboration/overview/ {
    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/federation/_category_.json
location = /docs/3.0/federation/_category_.json {
    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/federation/architecture/
location = /docs/3.0/federation/architecture/ {
    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/federation/basics/
location = /docs/3.0/federation/basics/ {
    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/federation/build-commands/
location = /docs/3.0/federation/build-commands/ {
    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/federation/cross-repo-relationships/
location = /docs/3.0/federation/cross-repo-relationships/ {
    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/federation/independent-subgraph-development/
location = /docs/3.0/federation/independent-subgraph-development/ {
    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/federation/overview/
location = /docs/3.0/federation/overview/ {
    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/migration-guide-from-hasura-v2/.wip
location = /docs/3.0/migration-guide-from-hasura-v2/.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/overview/.wip
location = /docs/3.0/overview/.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/architecture/private/byoc/
location = /docs/3.0/architecture/private/byoc/ {
    return 301 https://$host/docs/3.0/private-ddn/architecture/byoc/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/architecture/private/dedicated/
location = /docs/3.0/architecture/private/dedicated/ {
    return 301 https://$host/docs/3.0/private-ddn/architecture/dedicated/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/architecture/private/index/
location = /docs/3.0/architecture/private/index/ {
    return 301 https://$host/docs/3.0/private-ddn/architecture/index/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/architecture/private/self-hosted/
location = /docs/3.0/architecture/private/self-hosted/ {
    return 301 https://$host/docs/3.0/private-ddn/architecture/self-hosted/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/private-ddn/index/
location = /docs/3.0/private-ddn/index/ {
    return 301 https://$host/docs/3.0/private-ddn/overview/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/collaboration/_permissions/
location = /docs/3.0/collaboration/_permissions/ {
    return 301 https://$host/docs/3.0/project-configuration/_permissions/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/collaboration/_roles/
location = /docs/3.0/collaboration/_roles/ {
    return 301 https://$host/docs/3.0/project-configuration/_roles/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/collaboration/comment/
location = /docs/3.0/collaboration/comment/ {
    return 301 https://$host/docs/3.0/project-configuration/project-management/console-collaborator-comments/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/collaboration/service-accounts/
location = /docs/3.0/collaboration/service-accounts/ {
    return 301 https://$host/docs/3.0/project-configuration/project-management/service-accounts/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/federation/subgraph-prefixing/
location = /docs/3.0/federation/subgraph-prefixing/ {
    return 301 https://$host/docs/3.0/project-configuration/subgraphs/subgraph-prefixing/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/architecture/topology/
location = /docs/3.0/architecture/topology/ {
    return 301 https://$host/docs/3.0/reference/ddn-topology-architecture/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/roadmap/.wip
location = /docs/3.0/roadmap/.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/security/_category_.json
location = /docs/3.0/security/_category_.json {
    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/security/overview/.wip
location = /docs/3.0/security/overview/.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/upgrade/index/
location = /docs/3.0/upgrade/index/ {
    return 301 https://$host/docs/3.0/upgrade/overview/;
}

[hasura-bot]

DX: Assertion Testing

❌ Diff

The PR Diff shows a mass deletion of documentation files which, without any context or replacement, results in a loss of critical information about key features and guides (such as Federation and CI/CD). It removes the 'Architecture', 'Collaboration', and 'Federation' categories completely. This is not conducive to enhancing the usability of the documentation, as it strips away information without any indication of replication elsewhere or restructuring for improved clarity or cohesion.

❌ Integrated

The integration of this PR would significantly reduce the usability of the documentation. The removal of entire categories and crucial tutorials (such as onboarding teams and best practices), without apparent replacement or reorganization, will leave users without guidance. This disrupts the documentation's comprehensiveness and accessibility, making it challenging for users to find necessary information on Hasura DDN's architecture, collaboration features, and data federation capabilities, as well as potentially creating broken links and a disjointed user experience.

[hasura-bot]

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

[cloudflare-workers-and-pages]

Deploying ddn-docs with    Cloudflare Pages

Latest commit:	0a7067b
Status:	✅  Deploy successful!
Preview URL:	https://859ce558.v3-docs-eny.pages.dev
Branch Preview URL:	https://sean-doc-2403-finalise-restr.v3-docs-eny.pages.dev

View logs

[robertjdominguez]

Mate, I think this is a great reorganization and a much cleaner sidebar. Well done 🎉