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

Issue 309: Update documentation for 0.6.0 release #310

Merged
merged 8 commits into from
May 2, 2024

Conversation

osopardo1
Copy link
Member

@osopardo1 osopardo1 commented Apr 9, 2024

Description

Updates the documentation for 0.6.0 release. ( Also fixes #255 )

Type of change

Documentation update (updates regarding the Users docs or the Developer docs, or similar).

Checklist:

Here is the list of things you should do before submitting this pull request:

  • Update Spark Version on README.
  • Update Delta Version (and packages) on README.
  • Update Compatibility Matrix on README.
  • Update Spark & Delta Versions on CONTRIBUTING.

Copy link
Contributor

@fpj fpj left a comment

Choose a reason for hiding this comment

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

+1, lgtm

@osopardo1
Copy link
Member Author

Added some fix regarding the QbeastTable package in Quickstart.md and the README.md INSERT INTO example.

Copy link
Contributor

@fpj fpj left a comment

Choose a reason for hiding this comment

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

+1, thanks for the update.

Copy link
Contributor

@cdelfosse cdelfosse left a comment

Choose a reason for hiding this comment

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

LGTM

@osopardo1
Copy link
Member Author

osopardo1 commented Apr 22, 2024

Some TODO's For Documentation:

  • Update the API for Optimize. Make it clear to the user what are the different parameters (with Revision ID, with a sequence of files...)
  • Update the definition of Revision. What does a Revision contains?
  • Make clear statements about the behavior of the Optimize operation. What is expected when we call it with a special Revision ID?

Overall, we need to better explain the Revision concept, and how it interacts with Optimization for this upcoming release.

…haviour

Also update QbeastFormat.md and QbeastTable.md
@osopardo1 osopardo1 requested a review from fpj April 23, 2024 06:43
Copy link
Contributor

@fpj fpj left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, @osopardo1 . I have left a few comments, suggestions and questions.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
Copy link
Contributor

@fpj fpj left a comment

Choose a reason for hiding this comment

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

Really tiny typos, pls fix them quickly and I'll get this committed, it looks good otherwise.

docs/QbeastFormat.md Outdated Show resolved Hide resolved
docs/QbeastFormat.md Outdated Show resolved Hide resolved
@osopardo1 osopardo1 requested a review from fpj April 29, 2024 12:33
Copy link
Contributor

@fpj fpj left a comment

Choose a reason for hiding this comment

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

+1, lgtm.

@fpj fpj merged commit 6a8e1ca into Qbeast-io:main May 2, 2024
1 check 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.

Update Developers Guide version
4 participants