ConductR Documentation

Note that this project is EOL as of 2018-01-31.

Documentation for conductr.lightbend.com

Feel free to contribute and correct!

Dev Notes

This project has a few branches for the different versions of ConductR. master tracks the unreleased 2.2 version. Most changes should be made on both the master and 2.1 branches. You'll want to look into git cherry-pick to help facilitate this.

How to run ConductR doc locally

You will require sass or compass on the PATH. Refer to compass installation or sass installation for the actual installation step for your platform.

Clone the project-doc:

$ git clone https://github.com/typesafehub/project-doc

cd into the project-doc directory:

$ cd project-doc

Modify the app/modules/ConductRDocRendererModule.scala file to point to your PR change:

For example we are looking at PR 405.
This PR is based off the seglo repo, under the branch called licensing.
Modify ConductRDocRendererProvider21 to point to the PR repo and branch:

@Singleton
class ConductRDocRendererProvider21 @Inject()(actorSystem: ActorSystem, wsClient: WSClient)
  extends ConductRDocRendererProvider(
    actorSystem,
    wsClient,
    new URI("https://github.com/seglo/conductr-doc/archive/licensing.zip"),
    "2.1.x",
    versions
  )

Once this is done, run the project-doc:

$ sbt run

You will need to restart the project-doc process to immediately see the changes pushed to the PR branch.

typesafehub/conductr-doc

ConductR Documentation

Dev Notes

How to run ConductR doc locally