Add clarify for resource model #358
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
resouer
requested review from
hongchaodeng,
technosophos and
vturecek
as code owners
README.md
Outdated
| *This repository is unstable, and open to contributions.* | ||
| The specification is under development, and breaking changes could be made. | ||
| Interested in contributing? Take a look at the issue queue! We're looking for more | ||
| This specification is platform-neutral but adopts [Kubernetes API conventions (Kubernetes Resource Model)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/resource-management.md). We believe Kubernetes Resource Model will become the standard interface for majority platforms in the future, with different implementations are allowed. |
There was a problem hiding this comment.
Suggested change
| This specification is platform-neutral but adopts [Kubernetes API conventions (Kubernetes Resource Model)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/resource-management.md). We believe Kubernetes Resource Model will become the standard interface for majority platforms in the future, with different implementations are allowed. | |
| This specification adopts [Kubernetes API conventions (Kubernetes Resource Model)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/resource-management.md). We believe Kubernetes Resource Model will become the standard interface for majority of platforms in the future with different implementations. |
There was a problem hiding this comment.
for the majority of platforms
ryanzhang-oss
suggested changes
May 20, 2020
README.md
Outdated
| Interested in contributing? Take a look at the issue queue! We're looking for more | ||
| This specification is platform-neutral but adopts [Kubernetes API conventions (Kubernetes Resource Model)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/resource-management.md). We believe Kubernetes Resource Model will become the standard interface for majority platforms in the future, with different implementations are allowed. | ||
|
|
||
| *This repository is unstable, and open to contributions.* The specification is under development, and breaking changes could be made. Interested in contributing? Take a look at the issue queue! We're looking for more |
There was a problem hiding this comment.
Suggested change
| *This repository is unstable, and open to contributions.* The specification is under development, and breaking changes could be made. Interested in contributing? Take a look at the issue queue! We're looking for more | |
| *This repository is unstable and open to contributions.* The specification is under development and could adopt breaking changes in the future. Interested in contributing? Take a look at the issues! We're looking for more |
README.md
Outdated
| @@ -7,13 +7,13 @@ | |||
| |Mar 27th, 2020. OAM v1.0.0-alpha.2 is **RELEASED**! The new spec is highly extensible and native to Kubernetes runtime. Check the spec and [What's new in OAM v1alpha2](https://speakerdeck.com/resouer/whats-new-in-oam-v1alpha2-spec) for more detail!| | |||
| |Mar 26th, 2020. A proof-of-concept project named AWS ECS for OAM is published! Check [the AWS Labs repo ](https://github.com/awslabs/amazon-ecs-for-open-application-model) and have fun with developer centric experience with OAM + Fargate!| | |||
|
|
|||
| Open Application Model is a specification for building cloud native applications. | |||
| Open Application Model is a specification for defining cloud native applications and higher level abstractions. | |||
There was a problem hiding this comment.
what does "higher-level abstractions" refer to?
There was a problem hiding this comment.
For example, ContainerizedWorkload is a higher level abstraction for Deployment. Any better wording?
There was a problem hiding this comment.
It seems to me that an application is already a higher level concept than deployment, I thought the "higher-level abstraction" is even higher than an application.
There was a problem hiding this comment.
Then I will keep this sentence unchanged, this part is not a big deal.
README.md
Outdated
| *This repository is unstable, and open to contributions.* | ||
| The specification is under development, and breaking changes could be made. | ||
| Interested in contributing? Take a look at the issue queue! We're looking for more | ||
| This specification is platform-neutral but adopts [Kubernetes API conventions (Kubernetes Resource Model)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/resource-management.md). We believe Kubernetes Resource Model will become the standard interface for majority platforms in the future, with different implementations are allowed. |
There was a problem hiding this comment.
for the majority of platforms
|
@hongchaodeng @ryanzhang-oss comments addressed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
According offline discussion with @vturecek , and with v1alpha2 release of the spec, we can now update the README to reflect the fact that OAM has adopted Kubernetes API convention. This aligns with our vision that Kubernetes Resource Model will become the standard interface for majority platforms in the future, with different implementations are allowed.