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

Refactoring: Move tutorial-like content and references to cratedb-guide #82

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

amotl
Copy link
Member

@amotl amotl commented Feb 21, 2024

About

This patch refactors all the tutorial-like content and references to the new cratedb-guide documentation section.

Details

Because of followup cross-linking, this patch depends on the other patch to be integrated beforehand. Currently, it will fail on CI.

docs/conf.py Outdated
@@ -22,5 +22,8 @@
html_static_path = ['_static']


intersphinx_mapping["guide"] = ('https://cratedb-guide--29.org.readthedocs.build/', None)
Copy link
Member Author

Choose a reason for hiding this comment

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

Of course, 7098972 needs to be removed again before merging. It is only here to demonstrate everything fits together well, by making CI succeed.

Copy link
Member Author

Choose a reason for hiding this comment

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

The CrateDB Guide has been published, and this workaround has been removed.

@amotl amotl marked this pull request as ready for review February 21, 2024 21:10
@seut seut removed the request for review from matriv February 22, 2024 07:44
Copy link
Member

@seut seut left a comment

Choose a reason for hiding this comment

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

Isn't this complete repository obsolete after the migrations and can be archived completely? If so, I'd suggest to not remove stuff with PR's but archive the complete repository afterwards.

@amotl
Copy link
Member Author

amotl commented Feb 22, 2024

The repository isn't obsolete. It carries all the content visible at https://cratedb.com/docs/crate/clients/. We can think about further refactoring on subsequent iterations.

@amotl amotl requested a review from seut February 22, 2024 08:18
@amotl amotl force-pushed the amo/refactor-tutorial-references branch from 7098972 to b77d02a Compare March 6, 2024 20:36
@amotl amotl force-pushed the amo/refactor-tutorial-references branch from b77d02a to 017168f Compare March 6, 2024 20:45
@amotl amotl merged commit 0b3df8b into main Mar 6, 2024
4 checks passed
@amotl amotl deleted the amo/refactor-tutorial-references branch March 6, 2024 20:47
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