We welcome contributions to LoopBack documentation!
Page Contents

How LoopBack documentation works

LoopBack documentation is sourced in both the strongloop/loopback.io and strongloop/loopback-next GitHub repositories, and this site is generated using Jekyll and GitHub pages. Some pages are copied from the loopback-next repository’s master branch into loopback.io’s gh-pages branch, where this site is published from. Don’t use the master branch in the loopback.io repository.

When contributing documentation to the loopback-next repository, a new version of @loopback/docs must be published to npm before the changes appear live. There is a script that runs automatically at 3pm EST to propogate the changes to the loopback.io site.

All the pages from the loopback.io repo are in the pages directory and the pages from the loopback-next are stored in the docs/site directory, which are then copied to pages/en/lb4 in loopback.io. Every page also has an Edit this page button at the bottom that links to the page in the GitHub repo.

For information on contributing to translations in languages other than English, see Translation.

To contribute a change

Follow these steps:

  1. Click on Edit this page (top of page) to fork the repo.
  2. Edit the page or pages as needed.
  3. Commit to your fork/branch.
  4. Open a PR for your changes. If there is an associated issue, please reference it in your PR.

We attempt to review and merge PRs as soon as possible; in general, we’ll try to do so within 24 hours during the business week. Please allow longer over weekends or holidays.

Agreeing to the CLA

Like many open source projects, you must agree to the contributor license agreement (CLA) before we can accept (merge) your changes. See the loopback.io CLA and loopback-next CLA.

In summary, by submitting your code or doc contributions, you are granting us a right to use that code/content under the terms of this agreement, including providing it to others. You are also certifying that you wrote it, and that you are allowed to license it to us. You are not giving up your copyright in your work. The license does not change your rights to use your own contributions for any other purpose.

Contributor License Agreements are important because they define the chain of ownership of a piece of software. Some companies won’t allow the use of free software without clear agreements around code ownership. That’s why many open source projects collect similar agreements from contributors. The LoopBack CLA is based on the Apache CLA.

What to work on

We use GitHub issues to track tasks and bugs. In general:

  • For issues around documentation content (that is the actual information), open an issue in the relevant repository, such as loopback, loopback-datasource-juggler, loopback-connector-xxx, and so on.
    • Under loopback-next, use the Docs label.
  • For issue around the documentation site, layout, or UX, open an issue in the loopback.io repository.

For general guidelines on creating issues, see Reporting issues.

It is best practice to search first to make sure someone else hasn’t already logged your issue. Run these helpful GitHub queries to see open documentation issues:

References

The site theme is derived from Tom Johnson’s Documentation Theme for Jekyll. We’ve modified and extended it substantially to suit our needs. For more information, see the other pages in this section.

Other technical references: