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

Conversation

@hacksparrow
Copy link
Member

commented Apr 8, 2019

Addresses #2020.

@hacksparrow hacksparrow self-assigned this Apr 8, 2019

@hacksparrow hacksparrow requested review from bajtos and raymondfeng Apr 8, 2019

@hacksparrow hacksparrow force-pushed the doc/components branch from 1963576 to 07cfecd Apr 8, 2019

@hacksparrow hacksparrow marked this pull request as ready for review Apr 8, 2019

Show resolved Hide resolved docs/site/Concepts.md Outdated
@bajtos
Copy link
Member

left a comment

+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?

Show resolved Hide resolved docs/site/Components.md Outdated
Show resolved Hide resolved docs/site/Components.md Outdated
Show resolved Hide resolved docs/site/Components.md Outdated

@bajtos bajtos requested a review from bschrammIBM Apr 9, 2019

@hacksparrow hacksparrow force-pushed the doc/components branch 2 times, most recently from 6789fae to 8431296 Apr 11, 2019

@bajtos
Copy link
Member

left a comment

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.

Show resolved Hide resolved 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
@jannyHou
Copy link
Contributor

left a comment

LGTM in general 👍 Just post a confusion.

Show resolved Hide resolved docs/site/Components.md
Show resolved Hide resolved docs/site/Components.md Outdated

@hacksparrow hacksparrow force-pushed the doc/components branch from 8431296 to 80dc867 Apr 19, 2019

@hacksparrow

This comment has been minimized.

Copy link
Member Author

commented Apr 19, 2019

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

@bajtos

bajtos approved these changes May 6, 2019

@emonddr

emonddr approved these changes May 6, 2019

@hacksparrow hacksparrow force-pushed the doc/components branch from 80dc867 to b3f3848 May 6, 2019

@nabdelgadir
Copy link
Contributor

left a comment

LGTM besides two minor comments. 👍

Show resolved Hide resolved docs/site/Using-components.md Outdated
Show resolved Hide resolved docs/site/Components.md Outdated
docs: document Components
Elaborated the Component class

@hacksparrow hacksparrow force-pushed the doc/components branch from b3f3848 to 5d7dcd7 May 6, 2019

@hacksparrow hacksparrow merged commit 98bdce0 into master May 6, 2019

4 checks passed

clahub All contributors have signed the Contributor License Agreement.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 91.399%
Details

@dhmlau dhmlau referenced this pull request May 6, 2019

Closed

Add Component page under Key Concepts #2020

0 of 3 tasks complete

@bajtos bajtos deleted the doc/components branch May 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.