New section with Schema Diff

[soorajshankar]

Description

This PR introduces a new section called Builds similar to the new section in console. The idea of this section is to have a home for the following questions

• Where do I see the supergraph builds?
• Where do I see the connector builds?
• ... subgraph builds?

(Around Schema diff )

• What is the ideal process of applying a build? can I see the impact beforehand?
• What would schema-diff would do?
• What happens if I apply this build?

Checklist

• Validate the new section name before we merge this
• Should we add sections Supergraph Builds & Connector Builds along with this PR?

Quick Links 🚀

🤖 DX: Assertion Tests

[robertjdominguez]

Hey, @soorajshankar 👋

Thanks for this PR! Since you changed docs files, our automated Action assigned Rob as your reviewer 🎉

Before Rob 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.
• Rob will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Rob on Slack, and he'll give a docs review 🔥
• 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 Rob know the level of urgency on Slack 👍

[robertjdominguez]

DX: Assertion Testing

✅ Diff

The PR introduces coherent and clearly structured documentation for the API Change Management features. All markdown files have consistent header metadata and descriptions, which will help users navigate and understand the content easily. However, the connector-builds.mdx document's Content Time information seems incomplete. Please ensure that the details are appropriately formatted and complete.

✅ Integrated

The documentation PR appears to integrate well with the current documentation structure. The addition of the API Change Management category with corresponding icons enhances the navigation experience for the end user. Including real-life examples of schema changes within the context of Hasura DDN's functionality provides actionable insights for the users. The navigation path is maintained consistently (sidebar_pathname), ensuring a coherent user journey through the new documentation pages. However, please double-check the links in the overview cards, especially for 'Connector Builds', ensuring that they point to the correct paths.

[robertjdominguez]

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 33.9%, saving 84.13 KB.

Filename	Before	After	Improvement	Visual comparison
static/img/schema-diff/0.0.1_console_schema_diff_subview.png	89.88 KB	60.25 KB	-33.0%	View diff
static/img/schema-diff/0.0.1_console_schema_diff.png	158.19 KB	103.69 KB	-34.5%	View diff

153 images did not require optimisation.

[cloudflare-workers-and-pages]

Deploying v3-docs with    Cloudflare Pages

Latest commit:	c9881f8
Status:	✅  Deploy successful!
Preview URL:	https://343d1798.v3-docs-eny.pages.dev
Branch Preview URL:	https://schema-diff.v3-docs-eny.pages.dev

View logs

[robertjdominguez]

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 32.3%, saving 68.18 KB.

Filename	Before	After	Improvement	Visual comparison
static/img/schema-diff/0.0.1_console_schema_diff.png	210.82 KB	142.64 KB	-32.3%	View diff

154 images did not require optimisation.

[robertjdominguez]

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 37%, saving 39.93 KB.

Filename	Before	After	Improvement	Visual comparison
static/img/supergraph-builds/0.0.1_console_supergraph_builds.png	107.96 KB	68.03 KB	-37.0%	View diff

155 images did not require optimisation.

[robertjdominguez]

@soorajshankar — thanks for this!

After taking a look at the contents, I have clearer thoughts on how we should move forward with this. I'm struggling to see this as a dedicated top-level section, unless you folks + product think it's critical to highlight this in the sidebar.

Please let me know your thoughts to this idea:

• We have a section called Project Configuration that has a page called Builds
• I propose we modify this section's name to Project Management
• We take the content for Manage * Build and move them to the Builds page
• We reformat things a bit to cover lifecycles for a * build
• We move the CLI steps front-and-center and the means of accessing them via the console down on the page (i.e., frontload CLI steps with console as a backup)

Again, all of this is predicated on what product wants. If the desire is to make this top-level, then I think we follow a similar format to the change suggested above:

• Nuke the builds page in Project Configuration
• We reformat things a bit to cover lifecycles for a * build
• We move the CLI steps front-and-center and the means of accessing them via the console down on the page (i.e., frontload CLI steps with console as a backup)

[soorajshankar]

We have a section called Project Configuration that has a page called Builds

I had a chat with Manushi, Rikin and Console team, and we shared the same sentiment that lets keep it Build Management for now and once we have more Project Configuration features may be lets reconsider this, wdyt?

Update: Ahh I see the Project Configuration section is already there, let me see how we can refactor then

[robertjdominguez]

We have a section called Project Configuration that has a page called Builds

I had a chat with Manushi, Rikin and Console team, and we shared the same sentiment that lets keep it Build Management for now and once we have more Project Configuration features may be lets reconsider this, wdyt?

Update: Ahh I see the Project Configuration section is already there, let me see how we can refactor then

Cool 👍

I'll let you and @seanparkross carry this forward. He's taking over shepherding this starting with our new sprint today.

[hasura-bot]

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 35.9%, saving 37.80 KB.

Filename	Before	After	Improvement	Visual comparison
static/img/supergraph-builds/0.0.1_console_supergraph_builds.png	105.27 KB	67.47 KB	-35.9%	View diff

180 images did not require optimisation.

[seanparkross]

Sorry it has taken so long. This one totally fell off the radar. Back on now! Couple comments and we should be good to go

[seanparkross]

I feel like we could leave this bit out because we're in the overview / introduction section and the other parts do a great intro job without this.

Suggested change

	<p>
	A Supergraph is typically composed of multiple subgraphs, each potentially managed by different teams or services.
	These subgraphs may, in turn, consist of one or more connectors. This hierarchical structure means that changes at the
	connector or subgraph level can impact the overall Supergraph.
	</p>

[seanparkross]

This image is of supergraph not connector builds

[seanparkross]

One other question possibly not related to this PR... why is there nowhere to see subgraph builds?