Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] display beta warning and decorator info #26821

Merged
merged 2 commits into from
Jan 9, 2025

Conversation

maximearmstrong
Copy link
Contributor

@maximearmstrong maximearmstrong commented Jan 3, 2025

Summary & Motivation

Same as #25362 but for the new beta decorator introduced in #26748

Copy link

github-actions bot commented Jan 3, 2025

Copy link

github-actions bot commented Jan 3, 2025

Deploy preview for dagster-docs-beta ready!

Preview available at https://dagster-docs-beta-pqf6mfijs-elementl.vercel.app

Direct link to changed pages:

@cmpadden
Copy link
Contributor

cmpadden commented Jan 6, 2025

@maximearmstrong do we need to make any changes for the new docs as well? For example, I recall association a color, experimental -> warning in the MDX builder here:

https://github.com/dagster-io/dagster/blob/master/docs/sphinx/_ext/sphinx-mdx-builder/sphinxcontrib/mdxbuilder/writers/mdx.py#L950

Which is then styled in the CSS here:

https://github.com/dagster-io/dagster/blob/master/docs/docs-beta/src/styles/custom.scss#L622-L653

Copy link
Contributor

@cmpadden cmpadden left a comment

Choose a reason for hiding this comment

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

Approved.

I left a comment regarding the styling for Docusaurus, which we can address in a follow-up PR (if not already addressed).

@maximearmstrong maximearmstrong force-pushed the maxime/ad-758/add-preview-docs branch from 2b8ada1 to c70913b Compare January 9, 2025 15:33
@maximearmstrong maximearmstrong force-pushed the maxime/ad-759/add-beta-docs branch from 208deae to 4bc3aae Compare January 9, 2025 15:34
@maximearmstrong maximearmstrong force-pushed the maxime/ad-759/add-beta-docs branch from 4bc3aae to 67bcb49 Compare January 9, 2025 15:41
Base automatically changed from maxime/ad-758/add-preview-docs to master January 9, 2025 16:31
@maximearmstrong maximearmstrong force-pushed the maxime/ad-759/add-beta-docs branch from 67bcb49 to 5a08e93 Compare January 9, 2025 16:31
@maximearmstrong maximearmstrong merged commit 4a531e2 into master Jan 9, 2025
3 checks passed
@maximearmstrong maximearmstrong deleted the maxime/ad-759/add-beta-docs branch January 9, 2025 17:00
maximearmstrong added a commit that referenced this pull request Jan 9, 2025
…6846)

## Summary & Motivation

Map the Preview, Beta and Superseded flags to warning level for
Docusaurus/docs beta styling. See comment
[here](#26821 (comment)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants