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: document Component #2702

Merged
merged 1 commit into from
May 6, 2019
Merged

docs: document Component #2702

merged 1 commit into from
May 6, 2019

Conversation

hacksparrow
Copy link
Contributor

@hacksparrow hacksparrow commented Apr 8, 2019

Addresses #2020.

@hacksparrow hacksparrow self-assigned this Apr 8, 2019
@hacksparrow hacksparrow marked this pull request as ready for review April 8, 2019 12:39
docs/site/Concepts.md Outdated Show resolved Hide resolved
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

+1 to have a Components page in Key concepts.

I think it's important to rethink the organization of Component-related content we have for LB4 app developers (component consumers).

IMO:

  • "Components" page should provide a light-weight introduction to the concept of a Component
  • "Using Components" should go into more details about how to add a component to an application

@bschrammIBM @raymondfeng thoughts?

docs/site/Components.md Outdated Show resolved Hide resolved
docs/site/Components.md Outdated Show resolved Hide resolved
docs/site/Components.md Outdated Show resolved Hide resolved
@bajtos bajtos requested a review from bschrammIBM April 9, 2019 06:46
@hacksparrow hacksparrow force-pushed the doc/components branch 2 times, most recently from 6789fae to 8431296 Compare April 15, 2019 14:26
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

Looks much better now! I have few more comments to address, feel free to ignore the last one.

I think the documentation for component consumers & authors needs more reorganization and improvements, but that's out of scope of this pull request.

docs/site/Components.md Outdated Show resolved Hide resolved
docs/site/Using-components.md Outdated Show resolved Hide resolved
docs/site/Using-components.md Show resolved Hide resolved
docs/site/Components.md Show resolved Hide resolved
Copy link
Contributor

@jannyHou jannyHou left a comment

Choose a reason for hiding this comment

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

LGTM in general 👍 Just post a confusion.

docs/site/Components.md Show resolved Hide resolved
@hacksparrow
Copy link
Contributor Author

hacksparrow commented Apr 19, 2019

@bajtos I have updated the content based on your feedback, PTAL.

Copy link
Contributor

@nabdelgadir nabdelgadir left a comment

Choose a reason for hiding this comment

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

LGTM besides two minor comments. 👍

docs/site/Using-components.md Outdated Show resolved Hide resolved
docs/site/Components.md Outdated Show resolved Hide resolved
Elaborated the Component class
@hacksparrow hacksparrow merged commit 98bdce0 into master May 6, 2019
@dhmlau dhmlau mentioned this pull request May 6, 2019
3 tasks
@bajtos bajtos deleted the doc/components branch May 9, 2019 11:19
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.

7 participants