https://github.com/aws-quickstart/quickstart-documentation-example
Base for Quick Start Documentation
https://github.com/aws-quickstart/quickstart-documentation-example
Last synced: 10 months ago
JSON representation
Base for Quick Start Documentation
- Host: GitHub
- URL: https://github.com/aws-quickstart/quickstart-documentation-example
- Owner: aws-quickstart
- License: apache-2.0
- Created: 2020-05-06T03:35:06.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-03-25T18:28:19.000Z (over 4 years ago)
- Last Synced: 2024-11-19T07:14:57.901Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 7.63 MB
- Stars: 2
- Watchers: 7
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**This folder contains the base structure for AWS QuickStarts (New Repos will be auto populated with this structure**
## Docs
```
├── docs
│ ├── README.md
│ ├── common
│ ├── css
│ ├── generated
│ ├── images
│ └── index.adoc
```
Root folder Main Documentation (docroot)
### README.md
Render only when in github and serves as a description when browsing github
### common
```
├── common
│ ├── about_this_guide.adoc
│ ├── cost.adoc
│ ├── overview.adoc
│ └── troubleshoot.adoc
```
Generic content that will be liked from this repo to other docs via github
**Example:** To embed overview.adoc file from __common__
```
# add to this to index.adoc
include::https://raw.githubusercontent.com/aws-quickstart/quickstart-documentation-base/master/docs/common/overview.adoc
```
### css
```
├── css
└── quickstart.css
```
Hold documentation styles sheets
### generated
```
├── generated
└── parameter_table.adoc
```
Content in this folder will auto generated upon commits to master for example parameter tables
### images
Used to store images referenced in documentation
## Quick Start Reference Folders
**(scripts templates)**
### scripts
```
├── scripts
│ └── ngnix.conf
```
Hold scripts and config files used in cfn bootstrapping
### submodules
```
├── submodules
└── quickstart-aws-vpc
```
QuickStart submodules example: quickstart-aws-vpc
### templates
```
├── templates
├── master.template.yaml
└── workload.template.yaml
```
Cloudformation templates example: ( master.template.yaml)
### Workshops
```
├── workshops
├── awsworkshop.io
└── immersionday
```
**awsworkshop** (If this folder existing awsworkshop.io content will be updated in ghpages branch upon commits to master)
**immersionday** (If this folder existing immersionday modules will be updated in ghpages upon on commits to master)