JSPM

@atomist/docs-sdm

0.1.2-master.20190425184331
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q102151F
  • License Apache-2.0

an Atomist SDM to deliver documentation projects

Package Exports

  • @atomist/docs-sdm

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@atomist/docs-sdm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@atomist/docs-sdm

npm version

Atomist software delivery machine (SDM) for delivering our documentation.

See the Atomist documentation for more information on what SDMs are and what they can do for you using the Atomist API for software.

Features

Put TBD in Empty Sections

The putTbdInEmptySections autofix runs after every push, and replaces empty Markdown sections with a "To be disclosed" include. If you use this, be sure you use the include markdown extension and define a piece named tbd.md. You might prefer to copy the code and make a similar autofix of your own.

Prerequisites

See the Atomist Developer documentation for instructions on setting up your development environment. Briefly, you will need Git, Node.js, and the Atomist CLI installed and properly configured on your system. With these installed, you can run this SDM in local mode.

To run this SDM for your team, you will need an Atomist workspace. See the Atomist Getting Started Guide for instructions on how to get an Atomist workspace and connect it to your source code repositories, continuous integration, chat platform, etc.

Running

See the Atomist Developer documentation for details on how to run this SDM. Briefly, once the prerequisites are met on your system you can start the SDM in local mode with the following command:

$ atomist start --local

The Atomist documentation for running SDMs has instructions for connecting and SDM to the Atomist API for software and running an SDM in various environments.

Support

General support questions should be discussed in the #support channel in the Atomist community Slack workspace.

If you find a problem, please create an issue.

Development

You will need to install Node.js to build and test this project.

Build and test

Install dependencies.

$ npm install

Use the build package script to compile, test, lint, and build the documentation.

$ npm run build

Run locally in Docker

docker build -t docs-sdm .

To run in team mode, I need an API key accessible from the docker container. I populated #HOME/.atomist by running atomist config once.

docker run --rm --mount source=$HOME/.atomist,target=/root/.atomist,type=bind docs-sdm

Release

Releases are handled via the Atomist SDM. Just press the 'Approve' button in the Atomist dashboard or Slack.

Created by Atomist. Need Help? Join our Slack workspace.