[docs] Hello, Dagster becomes Quickstart #19981

cmpadden · 2024-02-22T18:09:49Z

Summary & Motivation

We would like to reduce the barrier to entry by replacing Hello, Dagster with a Quickstart project. This project leverages GitHub Codespaces, so that users can try Dagster without installing any dependencies on their local machine.

This is a part of a larger initiative of simplifying the entrypoints into Dagster and our documentation.

Checklist

Make the https://github.com/dagster-io/dagster-quickstart repo public

Outstanding Questions

We have a few quickstart templates that can already be scaffolded with the dagster command. Where do we want to draw the line on this quickstart vs those?

How I Tested These Changes

Ran Next.js project locally

cmpadden · 2024-02-22T18:10:02Z

Current dependencies on/for this PR:

[docs] increase admonition padding to 4 all around #19993
[docs] Hello, Dagster becomes Quickstart #19981 👈
master

This stack of pull requests is managed by Graphite.

github-actions · 2024-02-22T18:14:14Z

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-hdhleariz-elementl.vercel.app
https://colton-hello-dagster-to-quickstart.dagster.dagster-docs.io

Direct link to changed pages:

docs/content/getting-started/quickstart.mdx

hyperlint-ai

Hyperlint Summary for PR

Metric	Description	Value
Hyperlint Suggestions	Avg. # of Hyperlint suggestions / file	7.75
SEO Rating	Avg. The rating from 1 to 10 of the SEO quality of the document.	8.0
Readability Score	Avg. (ARI) Score	11.15

Hyperlint Review for `docs/content/getting-started.mdx`

Writing Quality Improvements

What Works Well:

The text is clear and informative.
Active voice is consistently used.
The flow of the text is improved through rephrasing.

Areas for Improvement:

Some sentences could be more concise.
The structure of sentences needs to be improved for easier understanding.
Readability and consistency should be further enhanced.

Hyperlint Review for `docs/content/getting-started/quickstart.mdx`

Summary of Proposed Changes

What Works Well:

The use of active voice and concise phrasing is consistently recommended, which will enhance clarity and engagement.
The appropriate use of markdown elements, such as links and code blocks, adds to the readability and functionality of the documentation.
The elimination of informal language and the push for a more professional tone are beneficial for maintaining the professional quality of the documentation.

Recommended Changes:

Further reduce passive voice across the documentation to ensure a more direct and engaging tone.
Increase conciseness in sentences to improve clarity and readability, avoiding redundancy and unnecessary details.
Restructure sentences and instructions to be more direct and professional, aligning with SEO best practices and enhancing user experience.

SEO Assessment

Change the page title from 'Dagster Quickstart | Dagster Docs' to 'Dagster Quickstart Guide: Getting Started with Dagster'. The proposed title is more descriptive and includes a call-to-action, which can improve SEO and user engagement.
We found several headings that could be improved for SEO. See the comments for details.
We found the following keywords as relvant for SEO: Dagster Quickstart, Dagster Docs, GitHub Codespaces, Running Locally, Exploring the UI, The Code Explained, Next Steps

Readability Assessment

Metric	Value
Automated Readability Index (ARI)	Tenth grade (score: 11.15)
Long Sentences	2
Passive Voice Sentences	4

Hyperlint Review for `docs/content/getting-started/what-why-dagster.mdx`

Proposed Changes Summary

Improvements:

The text is generally clear and concise.
The use of active voice is encouraged and improves readability.
Some rephrasing has been done to enhance clarity and conciseness.

Recommendations for Future Changes:

The section header should be more descriptive to better reflect the content.
The sentence in line 56 requires further improvement for readability.
Continue to review and revise for active voice where possible.

Hyperlint Review for `docs/content/integrations/pandas.mdx`

Proposed Changes Summary

Improvements:

The text clarity and readability have been enhanced through sentence restructuring.
Active voice is now used consistently, improving the engagement and directness of the content.
Instructions have been simplified, making them more accessible to the reader.

Recommendations for Future Revisions:

Continue to focus on simplifying complex sentences for better comprehension.
Maintain a consistent use of active voice to ensure a uniform reading experience.
Regularly review the markdown formatting to preserve the document's structure and readability.

docs/content/getting-started.mdx

docs/content/getting-started/quickstart.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

Co-authored-by: Erin Cochran <erin.k.cochran@gmail.com>

## Summary & Motivation We would like to reduce the barrier to entry by replacing Hello, Dagster with a Quickstart project. This project leverages GitHub Codespaces, so that users can try Dagster without installing any dependencies on their local machine. This is a part of a larger initiative of simplifying the entrypoints into Dagster and our documentation. ### Checklist - [ ] Make the https://github.com/dagster-io/dagster-quickstart repo public ### Outstanding Questions - We have a few _quickstart_ templates that can already be scaffolded with the `dagster` command. Where do we want to draw the line on this quickstart vs those? ## How I Tested These Changes - Ran Next.js project locally --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Erin Cochran <erin.k.cochran@gmail.com>

cmpadden commented Feb 22, 2024

View reviewed changes

docs/content/getting-started/quickstart.mdx Outdated Show resolved Hide resolved

cmpadden force-pushed the colton/hello-dagster-to-quickstart branch from 9d90301 to a65ef43 Compare February 22, 2024 18:41

cmpadden mentioned this pull request Feb 22, 2024

[docs] increase admonition padding to 4 all around #19993

Merged