Skip to content

Commit 07637f7

Browse files
dliggatdliggat
authored
Documentation generation (#412)
1 parent d5e0abf commit 07637f7

File tree

3 files changed

+176
-1
lines changed

3 files changed

+176
-1
lines changed

‎.github/workflows/documentation.yml‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
on: workflow_dispatch
2+
3+
name: Generate Documentation
4+
5+
jobs:
6+
7+
render:
8+
9+
name: Render
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v2
14+
- name: Install xetex
15+
run: |
16+
sudo apt-get install texlive-xetex
17+
sudo apt install librsvg2-bin
18+
sudo apt install 'fonts-dejavu*'
19+
20+
- name: Mkdir documentation
21+
run: |
22+
mkdir documentation
23+
24+
- name: PDF output 0
25+
uses: docker://pandoc/latex:2.10
26+
with:
27+
args: >
28+
--output=documentation/0-AWS-SEA-Solution-Summary.pdf
29+
--from=gfm
30+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
31+
-V linkcolor:blue
32+
-V geometry:paperwidth=8.5in
33+
-V geometry:paperheight=11in
34+
-V geometry:margin=.8in
35+
-V documentclass=report
36+
--pdf-engine=xelatex
37+
README.md
38+
39+
- name: PDF output 1
40+
uses: docker://pandoc/latex:2.10
41+
with:
42+
args: >
43+
--output=documentation/1-AWS-SEA-Installation-Guide.pdf
44+
--from=gfm
45+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
46+
-V linkcolor:blue
47+
-V geometry:paperwidth=8.5in
48+
-V geometry:paperheight=11in
49+
-V geometry:margin=.8in
50+
-V documentclass=report
51+
--pdf-engine=xelatex
52+
docs/installation/installation.md
53+
54+
- name: PDF output 2a
55+
uses: docker://pandoc/latex:2.10
56+
with:
57+
args: >
58+
--output=documentation/2a-AWS-SEA-Config-File-Options-ToC.pdf
59+
--from=gfm
60+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
61+
-V linkcolor:blue
62+
-V geometry:paperwidth=8.5in
63+
-V geometry:paperheight=11in
64+
-V geometry:margin=.8in
65+
-V documentclass=report
66+
--pdf-engine=xelatex
67+
docs/installation/customization-index.md
68+
69+
- name: Copy file output 2b
70+
run: |
71+
cp reference-artifacts/config.example.json documentation/2b-AWS-SEA-config.example.json
72+
73+
- name: PDF output 2c
74+
uses: docker://pandoc/latex:2.10
75+
with:
76+
args: >
77+
--output=documentation/2c-AWS-SEA-Multi-file-Config-Capabilities.pdf
78+
--from=gfm
79+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
80+
-V linkcolor:blue
81+
-V geometry:paperwidth=8.5in
82+
-V geometry:paperheight=11in
83+
-V geometry:margin=.8in
84+
-V documentclass=report
85+
--pdf-engine=xelatex
86+
docs/installation/multi-file-config-capabilities.md
87+
88+
- name: PDF output 2d
89+
uses: docker://pandoc/latex:2.10
90+
with:
91+
args: >
92+
--output=documentation/2d-AWS-SEA-Config-Sample-Snippets.pdf
93+
--from=gfm
94+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
95+
-V linkcolor:blue
96+
-V geometry:paperwidth=8.5in
97+
-V geometry:paperheight=11in
98+
-V geometry:margin=.8in
99+
-V documentclass=report
100+
--pdf-engine=xelatex
101+
./reference-artifacts/master-config-sample-snippets/sample_snippets.md
102+
103+
- name: Copy file output 2e
104+
run: |
105+
cp reference-artifacts/Third-Party/firewall-example.txt documentation/2e-AWS-SEA-firewall-example.txt
106+
107+
- name: PDF output 2f
108+
uses: docker://pandoc/latex:2.10
109+
with:
110+
args: >
111+
--output=documentation/2f-AWS-SEA-Firewall-config-Customizations.pdf
112+
--from=gfm
113+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
114+
-V linkcolor:blue
115+
-V geometry:paperwidth=8.5in
116+
-V geometry:paperheight=11in
117+
-V geometry:margin=.8in
118+
-V documentclass=report
119+
--pdf-engine=xelatex
120+
./reference-artifacts/master-config-sample-snippets/firewall_file_available_variables.md
121+
122+
- name: PDF output 3
123+
uses: docker://pandoc/latex:2.10
124+
with:
125+
args: >
126+
--output=documentation/3-AWS-SEA-Operations-Troubleshooting-Guide.pdf
127+
--from=gfm
128+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
129+
-V linkcolor:blue
130+
-V geometry:paperwidth=8.5in
131+
-V geometry:paperheight=11in
132+
-V geometry:margin=.8in
133+
-V documentclass=report
134+
--pdf-engine=xelatex
135+
docs/operations/operations-troubleshooting-guide.md
136+
137+
138+
139+
- name: PDF output 4
140+
uses: docker://pandoc/latex:2.10
141+
with:
142+
args: >
143+
--output=documentation/4-AWS-SEA-Developer-Guide.pdf
144+
--from=gfm
145+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
146+
-V linkcolor:blue
147+
-V geometry:paperwidth=8.5in
148+
-V geometry:paperheight=11in
149+
-V geometry:margin=.8in
150+
-V documentclass=report
151+
--pdf-engine=xelatex
152+
docs/developer/developer-guide.md
153+
154+
- name: PDF output 5
155+
uses: docker://pandoc/latex:2.10
156+
with:
157+
args: >
158+
--output=documentation/5-AWS-SEA-PBMM-Architecture.pdf
159+
--from=gfm
160+
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
161+
-V linkcolor:blue
162+
-V geometry:paperwidth=8.5in
163+
-V geometry:paperheight=11in
164+
-V geometry:margin=.8in
165+
-V documentclass=report
166+
--pdf-engine=xelatex
167+
docs/architectures/pbmm/architecture.md
168+
169+
- name: Zip
170+
run: |
171+
zip -r documentation.zip documentation/
172+
- uses: actions/upload-artifact@master
173+
with:
174+
name: documentation.zip
175+
path: documentation.zip

docs/operations/img/Upgrade-cfn.png renamed to docs/operations/img/upgrade-cfn.png

File renamed without changes.

‎docs/operations/operations-troubleshooting-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ This step calls a Lambda function that finds or creates the configuration reposi
183183

184184
The configuration file `config.json` or `config.yaml` is parsed and validated. This step will fail if both file types exist, the configuration file is not valid JSON or YAML or does not adhere to the configuration file specification. Internally the Accelerator always leverages JSON, but accepts JSON or YAML as the source input file and converts it to JSON prior to each execution, storing the converted and fully expanded file if in the raw folder.
185185

186-
![CodeCommit](img/CodeCommit-repo.png)
186+
![CodeCommit](img/codecommit-repo.png)
187187

188188
### 3.2.2. Get Baseline from Configuration
189189

0 commit comments

Comments
 (0)