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.

Sign up for GitHub

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

Jump to bottom

Document API guarantees for 1.0.0 #6626

Merged
merged 3 commits into from
Oct 2, 2023
Merged

Document API guarantees for 1.0.0 #6626

merged 3 commits into from
Oct 2, 2023

Conversation

arielshaqed
Copy link
Contributor

No description provided.

@github-actions
Copy link

No linked issues found. Please add the corresponding issues in the pull request description.
Use GitHub automation to close the issue when a PR is merged

@arielshaqed arielshaqed added docs Improvements or additions to documentation java Pull requests that update Java code area/sdk/python v1.0.0-blocker Issues that should be closed before going out with v1.0.0 labels Sep 20, 2023
@github-actions
Copy link

github-actions bot commented Sep 20, 2023 •
edited
Loading

♻️ PR Preview 34a9b7e has been successfully destroyed since this PR has been closed.

🤖 By surge-preview

@arielshaqed arielshaqed added exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached labels Sep 20, 2023
itaiad200
itaiad200 approved these changes Sep 23, 2023
View reviewed changes
Copy link
Contributor

@itaiad200 itaiad200 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 important document. I think our community should be involved as it effects them the most. Can we share it publicly to a larger audience?

docs/posts/towards-1.0-sdk.md Outdated

If your program only uses such calls on the SDK, it will continue to
compile and function across a minor version upgrade of the SDK.
* Any objects created by a lakeFS server version will continue to work after
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you define "any objects"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, thanks!

@arielshaqed
Copy link
Contributor Author

@itaiad200 said:

[...] I think our community should be involved as it effects them the most. Can we share it publicly to a larger audience?

Entirely agreed, I wanted to make sure that we have some agreement on these guarantees on the supply side before asking for comments on the demand side. SO now I invited review on #dev.

⬇️ ⬇️ ⬇️ ⬇️ Looking forward to seeing comments here!! ⬇️ ⬇️ ⬇️ ⬇️

Jonathan-Rosenberg
Jonathan-Rosenberg approved these changes Sep 26, 2023
View reviewed changes
docs/posts/images/1.0-is-coming.jpg Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

have you considered a UI designer position?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

y

E

s?

nopcoder
nopcoder approved these changes Oct 1, 2023
View reviewed changes
docs/posts/towards-1.0-sdk.md
of course a **major version upgrade**, and it will necessarily break some
client programs.

## Interface guarantees
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we like to specify that the S3 interface will change based on the compatibility with latest S3 interface?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea! I am adding a note to support the S3 API.

arielshaqed
arielshaqed commented Oct 2, 2023
View reviewed changes
Copy link
Contributor Author

@arielshaqed arielshaqed left a comment

Choose a reason for hiding this comment

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

Thanks!

I'm sending this out to our users :-)

docs/posts/images/1.0-is-coming.jpg Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

y

E

s?

docs/posts/towards-1.0-sdk.md
of course a **major version upgrade**, and it will necessarily break some
client programs.

## Interface guarantees
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea! I am adding a note to support the S3 API.

@arielshaqed arielshaqed enabled auto-merge (squash) October 2, 2023 07:01
@arielshaqed arielshaqed merged commit 58264f4 into master Oct 2, 2023
31 of 32 checks passed
@arielshaqed arielshaqed deleted the docs/towards-1.0-sdk branch October 2, 2023 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jonathan-Rosenberg Jonathan-Rosenberg Jonathan-Rosenberg approved these changes

@itaiad200 itaiad200 itaiad200 approved these changes

@nopcoder nopcoder nopcoder approved these changes

@ozkatz ozkatz Awaiting requested review from ozkatz

@kesarwam kesarwam Awaiting requested review from kesarwam

Assignees
No one assigned
Labels
area/sdk/python docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog java Pull requests that update Java code minor-change Used for PRs that don't require issue attached v1.0.0-blocker Issues that should be closed before going out with v1.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@arielshaqed @nopcoder @itaiad200 @Jonathan-Rosenberg