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: Establish VISION for "One Layer, All Storage" #5309

Merged
merged 15 commits into from
Nov 14, 2024
Merged

docs: Establish VISION for "One Layer, All Storage" #5309

merged 15 commits into from
Nov 14, 2024

Conversation

Xuanwo
Copy link
Member

@Xuanwo Xuanwo commented Nov 12, 2024

Which issue does this PR close?

Result of #5301

Rationale for this change

Establish VISION for "One Layer, All Storage"

What changes are included in this PR?

Update docs that refer to vision.

Are there any user-facing changes?

Not in the short term, but it will affect the entire future.

@Xuanwo Xuanwo requested a review from PsiACE as a code owner November 12, 2024 07:47
@Xuanwo
Copy link
Member Author

Xuanwo commented Nov 12, 2024

I also invite all @apache/opendal-committers to join the review.

Copy link
Member

@oowl oowl left a comment

Choose a reason for hiding this comment

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

LGTM

website/docs/vision.md Outdated Show resolved Hide resolved
Signed-off-by: Xuanwo <[email protected]>
website/docs/vision.md Outdated Show resolved Hide resolved
Signed-off-by: Xuanwo <[email protected]>
Copy link
Member

@PsiACE PsiACE left a comment

Choose a reason for hiding this comment

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

One Layer, All Storage 💯

Signed-off-by: Xuanwo <[email protected]>
website/docs/vision.md Outdated Show resolved Hide resolved
Copy link
Contributor

@wcy-fdu wcy-fdu left a comment

Choose a reason for hiding this comment

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

LGTM for the concept!

website/docs/vision.md Outdated Show resolved Hide resolved
Signed-off-by: Xuanwo <[email protected]>
website/docs/vision.md Outdated Show resolved Hide resolved
Copy link
Member

@dqhl76 dqhl76 left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM

website/docs/vision.md Outdated Show resolved Hide resolved
Copy link
Member

@suyanhanx suyanhanx left a comment

Choose a reason for hiding this comment

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

Thanks. That's great.

This comment was marked as off-topic.

Copy link
Member

@yuchanns yuchanns left a comment

Choose a reason for hiding this comment

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

LGTM

core/src/lib.rs Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

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

Generally LGTM. Comments inline.

Signed-off-by: Xuanwo <[email protected]>
Signed-off-by: Xuanwo <[email protected]>

For example, OpenDAL prefers to have clear and readable code, as this allows more people in the community to join the development.

### 1. Solid Foundation
Copy link
Contributor

Choose a reason for hiding this comment

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

-1 for Solid Foundation, as mentioned in #5301 (reply in thread)

IMO such a tenet is too big, hollow and subjective to provide guidance meaning and be constructive: no one will ever want to uncarefully build unsolid, untrustworthy software. It is self-evident to me that don't need to be told.

I propose the following alternatives:

  • Well-defined Behavior
  • Or Simply remove this one

Copy link
Member Author

Choose a reason for hiding this comment

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

no one will ever want to uncarefully build unsolid, untrustworthy software. It is self-evident to me that don't need to be told.

This is true. The closest comparison I can think of is the set of safety rules for flying a plane. No one wants the plane to crash, be damaged, or get lost, but that does happen. This principle exists to guide our development so that we don't make changes that lead us off track.

IMO such a tenet is too big, hollow and subjective to provide guidance meaning and be constructive

Yes, I agree that "solid foundation" is somewhat a big word. I'm open to better alternatives.

Well-defined Behavior

This phrase doesn't convey what we want in these areas.

Or Simply remove this one

Unfortunately, I believe we need to emphasize this area. Removing this one might leave our principles incomplete. I still suggest to use solid foundation if we don't have better one.

Copy link
Member

@Zheaoli Zheaoli left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@silver-ymz silver-ymz left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@morristai morristai left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor

@xyjixyjixyji xyjixyjixyji left a comment

Choose a reason for hiding this comment

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

In general LGTM, solid foundation seems somehow a vague word, but the explaination after it looks good.

@Xuanwo
Copy link
Member Author

Xuanwo commented Nov 14, 2024

Thank you all for the review, especially @tisonkun for the detailed comments and @xxchan for optimizing the expression. I'm going to merge this now.

Let's build "One Layer" for "All Storage"!

@Xuanwo Xuanwo merged commit 137843c into main Nov 14, 2024
274 checks passed
@Xuanwo Xuanwo deleted the add-vision branch November 14, 2024 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.