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

Move documentation to monorepo #1114

Closed
b-admike opened this issue Mar 9, 2018 · 4 comments
Closed

Move documentation to monorepo #1114

b-admike opened this issue Mar 9, 2018 · 4 comments

Comments

@b-admike
Copy link
Contributor

b-admike commented Mar 9, 2018

Description / Steps to reproduce / Feature proposal

A follow up to #843:

It would be great to have the documentation for loopback-next in the monorepo, so that we can keep documentation changes together with all other changes (runtime, CLI templates, API docs, etc.).
As part of the proposal, create the task

Acceptance Criteria

  • [ ] Create a script to trigger Travis build on loopback.io when there are changes made to @loopback/docs or loopback-next. We have a cron job set up for Travis which runs the builds once daily.
  • [ ] Create test coverage for the script which pulls down doc changes from loopback-next into loopback.io. You can do so with JavaScript. not needed at the moment as the script exits with non 0 status code if it fails to do a certain step.
  • [ ] Create a test on loopback.io which validates that npm start does not produce any errors. This would signify that Jekyll runs successfully. Travis/GitHub pages is smart enough to not push changes to production if a build fails and a developer can get the same result and debug by running the scripts and Jekyll locally.
    • After pulling in the readme's, @loopback/docs then run the testto make sure loopback.io still works
@shimks
Copy link
Contributor

shimks commented Mar 22, 2018

Most of the items in the criteria are done right?

@dhmlau
Copy link
Member

dhmlau commented Mar 23, 2018

Most of the items in the criteria are done right?

nope.

@b-admike , I forgot to ask when we're grooming this. Is there anything left that needs discussion or it's ready for estimate?

@b-admike
Copy link
Contributor Author

@dhmlau I think it's ready for estimation, but it's good to bring it up for discussion to see if anyone has questions about the criteria.

@b-admike b-admike removed their assignment Mar 23, 2018
@b-admike
Copy link
Contributor Author

b-admike commented Apr 3, 2018

After having a discussion with Diana, I'm closing this as we have determined the acceptance criteria for this ticket are accounted for (I've updated the ticket). If anyone has a different opinion or other criteria to add, we can re-visit this ticket and discuss further.

@b-admike b-admike closed this as completed Apr 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants