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.

Sign up for GitHub

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] Migrate docs from AsciiDoc to Markdown #2806

Merged
merged 8 commits into from
Mar 3, 2025
Merged

[docs] Migrate docs from AsciiDoc to Markdown #2806

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e76bf7e
delete asciidoc files
colleenmcginnis Feb 26, 2025
4601f82
add migrated files
colleenmcginnis Feb 26, 2025
fc0cc82
Fix Read the Docs build
pquentin Feb 26, 2025
3ab670e
fix links
colleenmcginnis Feb 26, 2025
c3b4208
Merge branch 'main' into migrate-docs
marciw Feb 27, 2025
349e54a
Merge branch 'main' into migrate-docs
marciw Feb 28, 2025
ad57e42
clean up cross-repo links
colleenmcginnis Feb 28, 2025
4a09380
Merge branch 'main' into migrate-docs
pquentin Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
488 changes: 488 additions & 0 deletions docs/docset.yml
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

What is this file about? Will it need to be kept up-to-date?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is used to configure the preview site for this repo. You can read more about it in the docs.

Copy link
Member

Choose a reason for hiding this comment

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

The docs document the format, but don't answer my question about future maintenance. Will the list of subs need to change in the future? It currently contains hundreds of entries, copy/pasted across all those projects, I'm assuming.

(I'm just trying to understand, I'm not going to block this or anything.)

Copy link
Contributor

Choose a reason for hiding this comment

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

fair questions! The docs team is on the hook for subs maintenance -- we had similar substitutions in the old system (and i'm thinking/hoping you didn't hear much about those)

in general I'd say docset.yml is something the docs team can/should keep an eye on 👍

Large diffs are not rendered by default.

141 changes: 0 additions & 141 deletions docs/guide/async.asciidoc
View file
Open in desktop

This file was deleted.

Loading
Loading