Skip to content

Commit

Permalink
docs design update (#7531)
Browse files Browse the repository at this point in the history 
What's new
- Layout following the new design
  * New header and background consistent with dagster.io
  * New nested left navigation
  * New breadcrumb bar at the top of the docs which includes
    - Version dropdown
    - Page hierarchy - not shown if only one layer (e.g. it doesn't show up for the landing page "Getting Started")
    - Feedback button
- Navigation:
  * Reduced unnecessary levels
  * Add cloud docs to top right nav
- Responsive layout: mobile, large/wide screen
  • Loading branch information
@yuhan
yuhan committed May 11, 2022
1 parent 03c8691 commit 8cb4101
Show file tree
Hide file tree
Showing 21 changed files with 1,655 additions and 1,456 deletions.
161 changes: 85 additions & 76 deletions docs/content/_navigation.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,20 @@
"path": "/getting-started",
"children": [
{
"title": "Getting Started",
"children": [
{
"title": "Installation",
"path": "/getting-started/install"
},
{
"title": "Create a New Project",
"path": "/getting-started/create-new-project"
},
{
"title": "Telemetry",
"path": "/getting-started/telemetry"
},
{
"title": "Releases and Changes",
"path": "/getting-started/releases"
}
]
"title": "Installation",
"path": "/getting-started/install"
},
{
"title": "Create a New Project",
"path": "/getting-started/create-new-project"
},
{
"title": "Telemetry",
"path": "/getting-started/telemetry"
},
{
"title": "Releases and Changes",
"path": "/getting-started/releases"
}
]
},
Expand Down Expand Up @@ -264,7 +259,7 @@
},
{
"title": "Deployment",
"icon": "Cloud",
"icon": "CloudUpload",
"path": "/deployment",
"children": [
{
Expand Down Expand Up @@ -398,55 +393,50 @@
"path": "/guides",
"children": [
{
"title": "Dagster Guides",
"title": "Versioning and Memoization (Experimental)",
"path": "/guides/dagster/memoization"
},
{
"title": "Software-Defined Assets Tutorial (Experimental)",
"path": "/guides/dagster/asset-tutorial",
"children": [
{
"title": "Versioning and Memoization (Experimental)",
"path": "/guides/dagster/memoization"
},
{
"title": "Software-Defined Assets Tutorial (Experimental)",
"path": "/guides/dagster/asset-tutorial",
"children": [
{
"title": "Defining an Asset",
"path": "/guides/dagster/asset-tutorial/defining-an-asset"
},
{
"title": "Building Graphs of Assets",
"path": "/guides/dagster/asset-tutorial/asset-graph"
},
{
"title": "Testing Assets",
"path": "/guides/dagster/asset-tutorial/testing-assets"
}
]
},
{
"title": "Software-Defined Assets with Pandas and PySpark (Experimental)",
"path": "/guides/dagster/software-defined-assets"
},
{
"title": "Run Attribution (Experimental)",
"path": "/guides/dagster/run-attribution"
},
{
"title": "Migrating to Graphs, Jobs, and Ops",
"path": "/guides/dagster/graph_job_op"
},
{
"title": "Re-execution",
"path": "/guides/dagster/re-execution"
"title": "Defining an Asset",
"path": "/guides/dagster/asset-tutorial/defining-an-asset"
},
{
"title": "Fully-Featured Example Project",
"path": "/guides/dagster/example_project"
"title": "Building Graphs of Assets",
"path": "/guides/dagster/asset-tutorial/asset-graph"
},
{
"title": "Validating Data with Dagster Type Factories",
"path": "/guides/dagster/dagster_type_factories"
"title": "Testing Assets",
"path": "/guides/dagster/asset-tutorial/testing-assets"
}
]
},
{
"title": "Software-Defined Assets with Pandas and PySpark (Experimental)",
"path": "/guides/dagster/software-defined-assets"
},
{
"title": "Run Attribution (Experimental)",
"path": "/guides/dagster/run-attribution"
},
{
"title": "Migrating to Graphs, Jobs, and Ops",
"path": "/guides/dagster/graph_job_op"
},
{
"title": "Re-execution",
"path": "/guides/dagster/re-execution"
},
{
"title": "Fully-Featured Example Project",
"path": "/guides/dagster/example_project"
},
{
"title": "Validating Data with Dagster Type Factories",
"path": "/guides/dagster/dagster_type_factories"
}
]
},
Expand Down Expand Up @@ -710,22 +700,41 @@
"path": "/community",
"children": [
{
"title": "Community",
"children": [
{
"title": "Code of Conduct",
"path": "/community/code-of-conduct"
},
{
"title": "Contributing",
"path": "/community/contributing"
},
{
"title": "Changing Public APIs",
"path": "/community/public-apis"
}
]
"title": "Code of Conduct",
"path": "/community/code-of-conduct"
},
{
"title": "Contributing",
"path": "/community/contributing"
},
{
"title": "Changing Public APIs",
"path": "/community/public-apis"
}
]
},
{
"title": "Changelog",
"icon": "Change",
"path": "/changelog",
"isUnversioned": true,
"children": [
{
"title": "Changelog",
"path": "/changelog",
"isUnversioned": true
},
{
"title": "Migration Guides",
"path": "/migration",
"isUnversioned": true
}
]
},
{
"title": "Dagster Cloud Docs",
"icon": "Cloud",
"path": "https://docs.dagster.cloud/",
"isExternalLink": true
}
]
7 changes: 6 additions & 1 deletion docs/next/__tests__/mdxInternalLinks.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@ test("No dead navs", async () => {
// TODO: Validate links to API Docs
return;
}
if (elem.path && !fileExists(path.join(DOCS_DIR, elem.path) + ".mdx")) {
if (
elem.path &&
!fileExists(path.join(DOCS_DIR, elem.path) + ".mdx") &&
!elem.isExternalLink &&
!elem.isUnversioned
) {
deadNavLinks.push({
title: elem.title,
deadLink: elem.path,
Expand Down

1 comment on commit 8cb4101

@vercel
Copy link

@vercel vercel bot commented on 8cb4101 May 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

dagster – ./docs/next

dagster.vercel.app
docs.dagster.io
dagster-git-master-elementl.vercel.app
dagster-elementl.vercel.app
new-docs.dagster.io

Please sign in to comment.