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

docs: Various documentation improvements #1005

Merged
merged 2 commits into from
Oct 8, 2024

Conversation

andygrove
Copy link
Member

@andygrove andygrove commented Oct 8, 2024

Which issue does this PR close?

N/A

Rationale for this change

Various documentation improvements:

  • Installation Guide:
    • Remove old content stating that we do not have published releases yet
    • Add direct links for downloading jar files from Maven
    • Move instructions for building from source to a separate guide to keep the main installation guide more concise
    • Enable shuffle in instructions for using Comet
    • Enable off-heap memory in instructions for using Comet
  • Comet plugin overview in user guide:
    • Use consistent language from README when describing the product
  • Comet plugin overview in contributor guide:
    • Use new versions of diagrams taken from recent CMU talk

What changes are included in this PR?

How are these changes tested?

@andygrove andygrove merged commit 837c256 into apache:main Oct 8, 2024
1 check passed
@andygrove andygrove deleted the docs-refresh branch October 8, 2024 21:16
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