Mission: Documentation Site

Mission: Documentation Site

Table of Contents

• Description
• User Problem
• Concepts and Architectural Patterns
• Prerequisites
• Use Case
• Acceptance Criteria
  • Vert.x-specific Acceptance Criteria
  • Swarm-specific Acceptance Criteria
  • Boot-specific Acceptance Criteria
  • Node.js-specific Acceptance Criteria
• Integration Requirements
• Tags
• Notes
• Approval

ID	Short Name
105	docs

Description

This mission provides a quick and easy way to create documentation or any static site and serve it up using Openshift.io. It allows users to write documentation using AsciiDoc, convert it to HTML, and host it as a static site using a microservice runtime.

Using AsciiDoc and Openshift.io to create a statically hosted site, such as a documentation site, as a microservice allows you to rapidly make changes while keeping your content in a portable, reusable format.

User Problem

User would like to create a static HTML site.

Concepts and Architectural Patterns

• HTML

• AsciiDoc

Prerequisites

• What is AsciiDoc?

Use Case

1. User navigates to /docs/ using a web browser.

2. User navigates to /docs/getting-started.html using a web browser.

3. User updates content in docs/getting-started/master.adoc and pushes changes.

4. User navigates to /docs/getting-started.html using a web browser to see updates.

5. User adds a new page called test-page.

   $ scripts/addGuide.sh test-page

6. User push changes.

7. User navigates to /docs/test-page.html using a web browser.

Acceptance Criteria

Vert.x-specific Acceptance Criteria

Swarm-specific Acceptance Criteria

Boot-specific Acceptance Criteria

Node.js-specific Acceptance Criteria

Integration Requirements

Tags

Notes

Approval

PM	Name	☐
DevExp	Name	☐
Vert.x	Name	☐
WildFly Swarm	Name	☐
Spring Boot	Name	☐
Node.js	Name	☐
QE	Name	☐
Docs	Name	☐
Architect	Name	☐