Skip to content

Proposal to make LoopBack documentation open source

Rand McKinney edited this page Jul 6, 2016 · 11 revisions

Issue

LoopBack docs are currently hosted in Confluence, and due to license and other practical constraints, this prevents the open-source community from editing the documentation directly. Because LoopBack is an open-source project, the docs should also be open source.

Proposed solution

Move doc content from Confluence into this repository, to enable public contributions/editing. Publish the docs to http://loopback.io/doc. Existing content on http://loopback.io would remain (essentially) unaffected.

It makes sense to time this move to coincide with LoopBack 3.0. Then, the "new" OS docs would then reflect the most recent version, and the existing docs on Confluence would be "frozen" to reflect v. 2.0 (as well as legacy 1.x docs).

As part of this migration, it may make sense to remove StrongLoop branding from the docs and rebrand them as simply "LoopBack" in keeping with the open-source nature of the project. See logos on http://loopback.io/resources/.

High-level tasks

  1. Create navigation framework similar to existing LH nav. Ideally, nav content would be sourced as nested lists in markdown and provide a nice "expandable" navigation widget.
  2. Migrate content from Confluence to markdown. See Migrating LoopBack Docs to Markdown for use with Jekyll for details.
  3. Create macro to link from (old) Confluence pages to corresponding/new loopback.io/doc pages.
  4. Publicize/socialize new site to encourage community participation.