Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 1.36 KB

ReadMe.md

File metadata and controls

27 lines (23 loc) · 1.36 KB

Purpose

An example template of files for a comprehensive solution architecture in a documentation-as-code approach.

Assumption(s)

Usage / Process

  • either git clone/fork or download a ZIP (and then unzip) of this GitHub repository
  • in the top-level directory, review/adjust/modify the following files:
    • DC-SA : to add/enable/disable any of the attributes/sections that you desire)
    • adoc/SA_vars.adoc : start adjusting the values of
      • useCase
      • title
      • author information
      • github references
    • adoc/SA.adoc : the main document
  • every portion of text that cites "FixMe" is a flag to encourage modification
  • as you edit the modular text content snippets, create an output format
    • daps --force -d DC-SA format
      • where format might be "pdf", "html", "html --single" and many others are also available
  • you can also add images/media content as needed in those subdirectories

Feedback

  • feel free to provide feedback, ask questions or even submit pull request