@atomist/docs-sdm

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

This machine runs in our cloud (and on my laptop, when I want it to) and delivers our documentation. It builds the markdown into a site using mkdocs, then ships the output to s3.

See the results in the Atomist docs.

Autofixes

Update code snippets

To reference code from the Atomist samples repository, reference it like this, with the file path (lib/command/helloWorld.ts) and a snippet name (helloWorldCommandAdd):

<!-- atomist:code-snippet:start=lib/command/helloWorld.ts#helloWorldCommandAdd -->
```typescript
sdm.addCommand(helloWorldCommand);

Meanwhile, get your code snippet into the master branch in the referenced file in samples, like this, with a snippet name.

// atomist:code-snippet:start=helloWorldCommandAdd
import { WeLoveToIncludeImportsInDocs } from "@atomist/sdm";

export function actualCodeGoesHere() {
    return "Hello, world!";
}
// atomist:code-snippet:end

The autofix will find the code in the samples repo and stick it between your delineating comments, along with a link to the source. See the results in the commands docs page.

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.