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

build(docs): include READMEs from all packages at publish time #2025

Merged
merged 1 commit into from
Nov 14, 2018

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented Nov 13, 2018

Add a script to copy per-package README files docs/site/readmes, run it as part of the release process.

This enhancement simplifies the process of including new READMEs in the documentation rendered at https://loopback.io, supersedes loopbackio/loopback.io#767 and makes loopback.io's script update-v4-readmes.sh pretty much obsolete.

To keep things simple, I am copying READMEs from almost all packages, even though those READMEs are not used yet. Skipped packages:

  • @loopback/docs
  • @loopback/benchmark
  • everything starting with @loopback/sandbox-

See also #2014 which will greatly benefit from this change.

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

Add a script to copy per-package README files `docs/site/readmes`,
run it as part of the release process.
@bajtos bajtos self-assigned this Nov 13, 2018
@bajtos bajtos requested review from raymondfeng and a team November 13, 2018 12:41
@bajtos bajtos changed the title build(docs): include package READMEs at publish time build(docs): include READMEs from all packages at publish time Nov 13, 2018
@bajtos bajtos added this to the November 2018 Milestone milestone Nov 13, 2018
Copy link
Contributor

@b-admike b-admike left a comment

Choose a reason for hiding this comment

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

LGTM; can we now remove our bash script in favour of this?

@bajtos
Copy link
Member Author

bajtos commented Nov 14, 2018

can we now remove our bash script in favour of this?

Yes please! But first we need to publish a new version of @loopback/docs that includes all READMEs.

@bajtos bajtos merged commit b7be5c9 into master Nov 14, 2018
@bajtos bajtos deleted the build/include-READMEs-in-docs branch November 14, 2018 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants