Storyboarded documentation files #355
Conversation
KeithJRome
requested review from
nmiodice,
ThePhen,
erikschlegel,
TechnicallyWilliams,
ianphil and
awkwardindustries
docs/3_NEW_STACK.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| # 3. Creating a New Stack | |||
There was a problem hiding this comment.
@iphilpot @erikschlegel If this PR is merged, we'll be introducing "Stack" as the official term for Cobalt Templates into the code base. I propose the following alternative: Kobalt Infrastructure Templates (KIT)
There was a problem hiding this comment.
Updated to use "template" nomenclature for now, as per today's discussion
There was a problem hiding this comment.
@KeithJRome @erikschlegel @TechnicallyWilliams How about we go with Cobalt Infrastructure Template (CIT) pronounced kit?
docs/1_USING_COBALT.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| # 1. Using and Customizing Cobalt | |||
|
|
|||
| [Documentation WIP] A series of hands-on labs that helps a user of Cobalt understand how to effectively create, test, and operationalize an infrastructure template ("stack"). | |||
There was a problem hiding this comment.
IMO, the concept of the "lab" should be expressed in our documentation but explicitly using the term "lab" feels academic, like a readme for a class room assignment. Would "manuals/tutorials" work better here?
@iphilpot @erikschlegel
There was a problem hiding this comment.
let's leave out lab/manual etc... KISS (Keep it Simple)
Co-Authored-By: Dexter Williams <dexterwilliams04@gmail.com>
All Submissions:
What is the current behavior?
To support users with adequate and current documentation of this project, a set of walkthroughs are being provided. These documents need a place to live.
Issue Number: #347
What is the new behavior?
This PR introduces a set of starter docs to contain the various walkthrough steps, along with an index doc.
Does this introduce a breaking change?
Any relevant logs, error output, etc?
(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)
Other information