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

Add SQL Scheduler docs #59

Merged
merged 6 commits into from
Mar 18, 2024
Merged

Add SQL Scheduler docs #59

merged 6 commits into from
Mar 18, 2024

Conversation

matkuliak
Copy link
Contributor

@matkuliak matkuliak commented Mar 11, 2024

What's Inside

Documentation for the new feature "SQL Job Scheduler"

Preview

https://crate-cloud--59.org.readthedocs.build/en/59/reference/overview.html#failed-cloning
(just below. why i'm linking to this explained below)

Highlights

  • Introduction of the feature

  • UI navigation to/around the feature. Explanation on the "Overview" and "Logs" tabs.

  • Examples

    • Cleanup job - removes entries older than 30 days, runs once a day
    • Copying to another table job - copies from system table into user created table - runs every hour
    • Didn't find any other good examples, feel free to send any my way if 2 is not enough or they're not good enough
  • Limitations and possible issues

  • PR also contains few unrelated link fixes, leftovers from cloud-docs rst->md conversion #55 that were not caught before. Also deletion of sign-up.rst, it complained about bunch of stuff and we don't need it anymore so deletion was easier.

Checklist

@matkuliak matkuliak added the documentation Improvements or additions to documentation label Mar 11, 2024
@matkuliak
Copy link
Contributor Author

Found one issue when I was going to link the header "SQL Scheduler". The consequence of this fix is that the header written this way can't be linked to. I will look for alternative, that should stop progress of this PR.

docs/_assets/img/cluster-sql-scheduler-example-copying.png Outdated Show resolved Hide resolved
docs/tutorials/sign-up.rst Outdated Show resolved Hide resolved
docs/tutorials/deploy/stripe.rst Outdated Show resolved Hide resolved
docs/tutorials/deploy/stripe.rst Outdated Show resolved Hide resolved
@matkuliak matkuliak requested a review from amotl March 11, 2024 23:01
Copy link
Member

@proddata proddata left a comment

Choose a reason for hiding this comment

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

Thanks 🙏

Copy link
Member

Choose a reason for hiding this comment

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

That file still weighs in with +507 KB. Is it legit?

Copy link
Member

Choose a reason for hiding this comment

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

From looking at other screenshots they're about average, no? Not sure I can do much more.

docs/_assets/img/cluster-sql-console.png from GH-66 is also pretty large, but I also can't get it smaller, even after reducing its physical width.

So, I figure it will be good to go. Thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, thought I was doing something wrong for a sec. But they are somewhat big, it's weird.
I will look into it a bit more. Thank you.

Copy link
Member

Choose a reason for hiding this comment

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

+326 KB for that one. Acceptable?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Used oxipng on all of them 🤷🏻‍♂️
From looking at other screenshots they're about average, no? Not sure I can do much more.

Copy link
Member

Choose a reason for hiding this comment

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

I just wonder why that one is much larger than the others.

@matkuliak matkuliak merged commit 217b3a6 into main Mar 18, 2024
3 checks passed
@matkuliak matkuliak deleted the mm/sql-job-scheduler branch March 18, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants