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

DOC-594 refactor new API docs #26296

Merged
merged 4 commits into from
Dec 5, 2024
Merged

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Dec 5, 2024

Summary & Motivation

Copy API docs to /api/python-api instead of /api to give us space in the /api docs section for narrative docs.

How I Tested These Changes

Staging build -- I was unable to build API docs locally.

Changelog

Insert changelog entry or delete this section.

@neverett neverett self-assigned this Dec 5, 2024
@neverett neverett requested a review from cmpadden December 5, 2024 20:57
@neverett
Copy link
Contributor Author

neverett commented Dec 5, 2024

Not sure what's up with the buildkite failure, that seems unrelated to me, but I could be wrong.

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.

In preview deployment I confirmed:

  • /api prose is accessible
  • /python-api renders correctly

@cmpadden
Copy link
Contributor

cmpadden commented Dec 5, 2024

Not sure what's up with the buildkite failure, that seems unrelated to me, but I could be wrong.

oss-internal-compat can be ignored for docs/ changes. I see it fail every now and then, and I think it can be resolved by rebasing master, but not necessary.

@neverett neverett merged commit 5425862 into master Dec 5, 2024
3 of 4 checks passed
@neverett neverett deleted the nikki/docs/DOC-594-api-docs-refactor branch December 5, 2024 21:24
@neverett neverett added the area:docs-revamp Related to the revamp of the docs label Dec 5, 2024
pskinnerthyme pushed a commit to pskinnerthyme/dagster that referenced this pull request Dec 16, 2024
## Summary & Motivation

Copy API docs to /api/python-api instead of /api to give us space in the
/api docs section for narrative docs.

## How I Tested These Changes

Staging build -- I was unable to build API docs locally.

## Changelog

> Insert changelog entry or delete this section.

---------

Signed-off-by: nikki everett <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs-revamp Related to the revamp of the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants