Deborah Barnard StarfallProjects

Documentation Engineering Consulting Agreement

There are 28 static site generators that support AsciiDoc sourcing.

First install Termux

Then there are two options:

Build from source

Open the Termux terminal on your Android device and copy-and-paste the commands listed below and hit ENTER:

Documentation-Driven Development

The philosophy behind Documentation-Driven Development is a simple: from the perspective of a user, if a feature is not documented, then it doesn't exist, and if a feature is documented incorrectly, then it's broken.

Document the feature first. Figure out how you're going to describe the feature to users; if it's not documented, it doesn't exist. Documentation is the best way to define a feature in a user's eyes.
Whenever possible, documentation should be reviewed by users (community or Spark Elite) before any development begins.
Once documentation has been written, development should commence, and test-driven development is preferred.
Unit tests should be written that test the features as described by the documentation. If the functionality ever comes out of alignment with the documentation, tests should fail.
When a feature is being modified, it should be modified documentation-first.
When documentation is modified, so should be the tests.

Deploying a subfolder to GitHub Pages

Sometimes you want to have a subdirectory on the master branch be the root directory of a repository’s gh-pages branch. This is useful for things like sites developed with Yeoman, or if you have a Jekyll site contained in the master branch alongside the rest of your code.

For the sake of this example, let’s pretend the subfolder containing your site is named dist.

Step 1

Remove the dist directory from the project’s .gitignore file (it’s ignored by default by Yeoman).

	// $ node lint-openapi-with-vale.js https://link-to-my/swagger.json

	const axios = require('axios');
	const { exec } = require('child_process');

	async function fetchSwaggerJson(remoteUrl) {
	try {
	const response = await axios.get(remoteUrl);
	return response.data;
	} catch (error) {

	# Courtesy of: https://stackoverflow.com/a/11974399

	{%- for item in items %}
	[
	"{{item}}"{{ "," if not loop.last }}
	]
	{%- endfor %}

	# From your Google Spreadsheet, select the menu item Tools > Script editor.
	# Copy and paste this code.
	# Replace uuid with the build_hooks uuid from your Netlify project.

	function onOpen() {
	SpreadsheetApp.getUi()
	.createMenu('Scripts')
	.addItem('Build', 'build')
	.addToUi();
	}

	import json
	import requests
	import csv

	# Authentication for user filing issue (must have read/write access to
	# repository to add issue to)
	USERNAME = 'username'
	PASSWORD = 'password'

	# The repository to add this issue to