[Docs] Cosmos docs home restructure

[lzdanski]

Description

This PR is a first iteration of updates to the Home page for the Cosmos docs. It simplifies the content to allow users to quickly understand what Cosmos is, how it works, how to get started, and how to get help.

This PR only moves content, it does not edit, add, or rewrite docs. Those will be in follow-up PRs.

In this PR it specifically:

• Moves information about Jaffle Shop to the Getting Started section, where it is proximal to the getting started guides, where it can be used.

• Moves content relating to Contributing and Compatibility to a new section called "Project Policies"
• Moves license, security, project structure, and privacy statement to a section called "Compatibility, Privacy, and Security Policies"

• Adds redirects for relocated content
• Updates links broken by relocated content

Discussion feedback

• Are there any essential sections of the current home page that must stay on the home page and should not be moved to other parts of the doc?
• If we could pick 3 essential docs to share with users on the front page, what would they be?

Related Issue(s)

N/A

Breaking Change?

Could cause broken links.

Checklist

• [ x] I have made corresponding changes to the documentation (if required) - hardcoded links have been updated.

• I have added tests that prove my fix is effective or that my feature works

• No build errors

• redirects tested and resolved

[pankajastro]

Hey @lzdanski , thanks for submitting the PR!

I noticed in the final agreed navigation section of the doc, the top-level H1 headings are:

• Home
• Getting Started
• Guides
• Reference
• Project Policies

But in the PR description, some top-level headings look different—for example, I can still see Profile as a top-level heading. Could we align these with the agreed navigation? Or are you planning to update them in a separate PR?

[lzdanski]

But in the PR description, some top-level headings look different—for example, I can still see Profile as a top-level heading. Could we align these with the agreed navigation? Or are you planning to update them in a separate PR?

For record keeping - discussed in sync. These changes will be accounted for in separate PRs. See #2418 for additional content structure changes.

[yetudada]

Approving this PR since it’s primarily a re-organization of the existing information rather than an improvement of the content itself, and the new structure makes sense to me. But I want @pankajastro or @tatiana to take a look at this.

One thing I noticed when building the docs is that some of the headings look a bit inconsistent, particularly in the Cosmos security, compliance, and privacy policies section. The header sizes seem to vary, so it might be worth standardizing those.

There’s also some inconsistency around title formatting, for example sentence case vs. capitalised titles. I assume that can be cleaned up in a follow-up PR.

[lzdanski]

• Fixed heading sizes on the Security page
• Headers, page titles, and navbar item capitalization will be addressed in a final cleanup PR next week, it will cause a lot of conflicts to try and address right now

[tatiana]

Thanks for improving the docs, @lzdanski !

[tatiana]

I renamed the section Changelog in Policy to Versioning Policy. Thanks for addressing the feedback I gave on the repeated "Why" and other parts of the content, @lzdanski !

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.98%. Comparing base (e38da03) to head (61813a7).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2416   +/-   ##
=======================================
  Coverage   97.98%   97.98%           
=======================================
  Files         103      103           
  Lines        7085     7085           
=======================================
  Hits         6942     6942           
  Misses        143      143           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.