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

improve README and add story-based introduction #190

Merged
merged 4 commits into from
Oct 9, 2019
Merged

improve README and add story-based introduction #190

merged 4 commits into from
Oct 9, 2019

Conversation

hongchaodeng
Copy link
Member

@hongchaodeng hongchaodeng commented Oct 7, 2019 •
edited
Loading

@hongchaodeng hongchaodeng mentioned this pull request Oct 7, 2019
Closed
11 tasks
xiang90
xiang90 reviewed Oct 8, 2019
View reviewed changes
introduction.md Outdated Show resolved Hide resolved
xiang90
xiang90 reviewed Oct 8, 2019
View reviewed changes
introduction.md Outdated Show resolved Hide resolved
tomkerkhove
tomkerkhove reviewed Oct 8, 2019
View reviewed changes
introduction.md Outdated Show resolved Hide resolved
tomkerkhove
tomkerkhove reviewed Oct 8, 2019
View reviewed changes
introduction.md Outdated Show resolved Hide resolved
@tomkerkhove
Copy link
Contributor

I like the intro, helps put it in perspective for new folks.

One suggestion would maybe be to provide a high-level picture that represents everything?

Bonus points if it involves how you can deploy same thing to 2 different runtimes

@hongchaodeng
Copy link
Member Author

comments addressed.

One suggestion would maybe be to provide a high-level picture that represents everything?

Yeah. Put it in front page in READM actually :)

Bonus points if it involves how you can deploy same thing to 2 different runtimes

Coming soon...

@tomkerkhove
Copy link
Contributor

@hongchaodeng Good point, sorry I've missed that one

suhuruli
suhuruli suggested changes Oct 9, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
introduction.md Outdated Show resolved Hide resolved
@hongchaodeng
Copy link
Member Author

@suhuruli fixed

xiang90
xiang90 reviewed Oct 9, 2019
View reviewed changes
introduction.md Outdated Show resolved Hide resolved
xiang90
xiang90 reviewed Oct 9, 2019
View reviewed changes
introduction.md Outdated Show resolved Hide resolved
@hongchaodeng
Copy link
Member Author

fixed

vturecek
vturecek approved these changes Oct 9, 2019
View reviewed changes
Copy link
Member

@vturecek vturecek 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 @hongchaodeng !

@xiang90
Copy link
Contributor

xiang90 commented Oct 9, 2019

LGTM

@vturecek vturecek added the documentation Improvements or additions to documentation label Oct 9, 2019
@vturecek vturecek added this to the 1.0.0-alpha1 milestone Oct 9, 2019
@vturecek vturecek merged commit a3981e2 into oam-dev:master Oct 9, 2019
@hongchaodeng hongchaodeng deleted the refarch branch October 9, 2019 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xiang90 xiang90 xiang90 left review comments

@tomkerkhove tomkerkhove tomkerkhove left review comments

@suhuruli suhuruli suhuruli approved these changes

@vturecek vturecek vturecek approved these changes

@mikkelhegn mikkelhegn Awaiting requested review from mikkelhegn

@technosophos technosophos Awaiting requested review from technosophos

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
1.0.0-alpha1
Development

Successfully merging this pull request may close these issues.

Consider refactor several spec docs to "example first"?
5 participants
@hongchaodeng @tomkerkhove @xiang90 @vturecek @suhuruli