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

Migration guide fix #889

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Conversation

Lorak-mmk
Copy link
Collaborator

This PR fixes 2 problems:

  • One broken link to new migration guide.
  • Table not rendering correctly in migration guide. It looks like Scylla's documentation system doesn't support tables in Markdown.

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce.
  • I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description.

@Lorak-mmk Lorak-mmk requested a review from piodul December 19, 2023 14:21
@Lorak-mmk
Copy link
Collaborator Author

Lorak-mmk commented Dec 19, 2023

@dgarcia360 Regarding second point, are we doing something wrong or tables are really not supported? It is rendered correctly by both VSCode and mdbook, but not in Scylla docs
image

@piodul
Copy link
Collaborator

piodul commented Dec 19, 2023

Sorry for the sloppiness on my side. The table looked correct in vscode/github, but AFAIK tables are a markdown extension, so I shouldn't take it for granted that sphinx supports it.

As for the incorrect file name in the link, it looks like something that should be caught by CI. I am surprised that mdbook (?) doesn't produce an error. Maybe it's possible to adjust the CLI flags to catch issues like that in the future.

@Lorak-mmk Lorak-mmk merged commit e482455 into scylladb:branch-0.11.x Dec 19, 2023
9 checks passed
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.

2 participants