[DRAFT] Add Reference docs section#2424
Closed
lzdanski wants to merge 37 commits into
Closed
Conversation
lzdanski
changed the title
pankajastro
reviewed
Mar 3, 2026
Contributor
pankajastro
left a comment
pankajastro
left a comment
There was a problem hiding this comment.
@lzdanski Do we need to check in those profile mapping docs files, given that they’re auto-generated?
Contributor
Author
I don't think we need them. I've also updated the template to use the two code backticks anyways, which was triggering the failure. |
1 task
Co-authored-by: Pankaj Singh <98807258+pankajastro@users.noreply.github.com>
Contributor
Author
|
Closing PR due to a git rebase issue. |
tatiana
pushed a commit
that referenced
this pull request
Mar 6, 2026
- Renames *Source Nodes Rendering* page to *Managing Sources* per navigation structure discussion - Updates all relative links so that images and code examples render as expected - Adds redirects for all relocated content - Aligns getting started guide navigation labels to be more consistent ### Things this PR does **not** cover that are addressed in other PRs: - This PR does not align titles and navigation labels for newly relocated Execution Modes docs and overview doc (lzdanski#2) - It does not add additional content to newly created index landing pages for the subfolders of the new TOC categories - It does not add new content to the Getting Started/ Cosmos Fundamentals section - It does not move `Profiles` docs into `References` (#2424) ## Restructuring work - Restructures the Getting Started section to have a dedicated space for core concepts called "Cosmos Fundamentals", and another section for getting started guides. <img width="1459" height="506" alt="Screenshot 2026-03-01 at 10 03 01 PM" src="https://github.com/user-attachments/assets/c3e13648-bcc5-481a-958c-3e48fcb5ed6e" /> - Renames "Configuration" to "Guides", Moves execution modes docs from "Getting started" to "Guides" section, adds new categories to the "Guides" section <img width="1462" height="787" alt="Screenshot 2026-03-01 at 10 03 08 PM" src="https://github.com/user-attachments/assets/0a60a3d1-780c-4bb2-b40e-c643c5abb407" /> - Adds a new category of docs called "Optimize Performance" for advanced configuration topics <img width="1446" height="530" alt="Screenshot 2026-03-01 at 10 07 23 PM" src="https://github.com/user-attachments/assets/8bba6494-4125-4704-9a64-594a66a16e6d" /> - Adds a section called "References" for glossary/configs/and other reference material. <img width="1402" height="368" alt="Screenshot 2026-03-01 at 10 07 35 PM" src="https://github.com/user-attachments/assets/d4cf12d2-c3c4-40ce-9d19-6951514c1bc3" /> ## Related Issue(s) Related to the following open PR's: - #2398 - #2416 - #2424
2 tasks
pankajastro
pushed a commit
that referenced
this pull request
Mar 11, 2026
## Description This PR restructures the **Reference** Section, creates the new **Guides>Connect database** section from the existing [Profiles Overview page](https://astronomer.github.io/astronomer-cosmos/profiles/index.html). It replaces #2424. <img width="1470" height="738" alt="Screenshot 2026-03-11 at 10 03 06 AM" src="https://github.com/user-attachments/assets/e710fb79-e000-40d1-8091-c65825576a6d" /> - It removes the redundant [**Profile Config** page](https://astronomer.github.io/astronomer-cosmos/reference/configs/profile-config.html) -> this refactoring would have had two different "Profiles" pages in the reference section - Adds the **Profiles** mappings to the **Reference** sidebar and hides the list of profile mappings from the Profiles Index overview. <img width="1453" height="791" alt="Screenshot 2026-03-06 at 2 48 09 PM" src="https://github.com/user-attachments/assets/0e1105d3-6a76-4069-8f70-34323ed09f8a" /> - Moves the contents of the [Profiles Index Overview page](https://astronomer.github.io/astronomer-cosmos/profiles/index.html) into three new pages in the **Connect database** section. NOTE - due to issue in local build, the sidebar appears inconsistent in screenshots. <img width="1469" height="811" alt="Screenshot 2026-03-06 at 2 48 17 PM" src="https://github.com/user-attachments/assets/3915d4ce-5c25-4576-af18-350b9b171939" /> <img width="1463" height="730" alt="Screenshot 2026-03-06 at 2 48 26 PM" src="https://github.com/user-attachments/assets/a2bbf5cc-07c7-43cf-ae84-bf5c80641bbe" /> <img width="1451" height="827" alt="Screenshot 2026-03-06 at 2 48 35 PM" src="https://github.com/user-attachments/assets/cbf81c2d-9bdf-4d9c-a8e6-2411d2ff0241" /> <img width="1463" height="819" alt="Screenshot 2026-03-06 at 2 48 51 PM" src="https://github.com/user-attachments/assets/ee7c4f6e-fd48-4d0a-a01b-144063e02170" /> <img width="1470" height="360" alt="Screenshot 2026-03-06 at 2 49 00 PM" src="https://github.com/user-attachments/assets/f83cc2d2-3d10-474d-b8c5-69c83d27a9e8" /> <img width="1470" height="688" alt="Screenshot 2026-03-06 at 2 49 07 PM" src="https://github.com/user-attachments/assets/391feac7-8272-4cd5-ab73-e60651245e98" /> - **Discussion question**: disabling dbt event tracking might not fit on the current page in the "Connect Database", and would need to be relocated. <img width="1466" height="630" alt="Screenshot 2026-03-06 at 2 49 15 PM" src="https://github.com/user-attachments/assets/0af63bfb-90ae-484f-812a-bfbb12d7dc2d" /> ## Related Issue(s) <!-- If this PR closes an issue, you can use a keyword to auto-close. --> <!-- i.e. "closes #0000" --> ## Breaking Change? <!-- If this introduces a breaking change, specify that here. --> Possible docs broken links. Moved files have been compared to the list of redirects created to reduce this possibility. ## Checklist - [ ] I have made corresponding changes to the documentation (if required) - [ ] I have added tests that prove my fix is effective or that my feature works
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR moves the
Profilessection into a sub-directory of the newReferencesection in the docs.This also includes the Configuration reference materials.
The "Profiles" sidebar navigation has this structure, and can't be collapsed in the sidebar navigation, because it uses refs generated by
profiles_mapping.pyin the toctree instead of the file names/directories.Remaining work
Related Issue(s)
Breaking Change?
Checklist