-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathindex.html
475 lines (342 loc) · 19.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to Playing with PlantUML! — Playing with PlantUML documentation</title>
<link rel="shortcut icon" href="_static/plantumllogo.png"/>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="1. About PlantUML" href="AboutPlantUML.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Playing with PlantUML
<img src="_static/plantumllogo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="AboutPlantUML.html">1. About PlantUML</a></li>
<li class="toctree-l1"><a class="reference internal" href="AboutThisGuide.html">2. About this Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">Stdlib</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html">1. Plantuml Sprites</a></li>
<li class="toctree-l1"><a class="reference internal" href="PlantUMLSpriteLibraries/PlantUMLSprites.html">2. Understanding PlantUML Stdlib Sprite Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html">3. Create a Diagram of a Typical Network</a></li>
<li class="toctree-l1"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html">4. Create a Template from our Network Diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StandardisingSrdLib.html">5. StandardisingStdLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/ContributingToStdlib.html">6. ContributingToStdlib</a></li>
</ul>
<p class="caption"><span class="caption-text">C4</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="C4/C4Stdlib.html">1. Using PlantUML Stdlib C4 Lightweight Software Architecture Description Method</a></li>
</ul>
<p class="caption"><span class="caption-text">New ways to Run PlantUML</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="GenerateDiagrams/GenerateDiagrams.html">1. Generate diagrams from PlantUML source files using GithubActions</a></li>
<li class="toctree-l1"><a class="reference internal" href="GenerateDiagrams/GenerateDiagramsLambda.html">2. Generate diagrams from PlantUML source files using AWS Lambda</a></li>
</ul>
<p class="caption"><span class="caption-text">Annex</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="C4/c4.html">1. C4 Lightweight Software Architecture Description Method</a></li>
<li class="toctree-l1"><a class="reference internal" href="DocumentationAsCode/JourneyDocumentationASCode.html">2. Journey to Documentation as Code</a></li>
</ul>
<p class="caption"><span class="caption-text">ToDo</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="todo.html">1. To Do List</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Playing with PlantUML</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Welcome to Playing with PlantUML!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-playing-with-plantuml">
<h1>Welcome to Playing with PlantUML!<a class="headerlink" href="#welcome-to-playing-with-plantuml" title="Permalink to this headline">¶</a></h1>
<div class="align-center figure" id="id4">
<a class="reference internal image-reference" href="_images/plantumllogo.png"><img alt="alternate text" src="_images/plantumllogo.png" style="width: 200px; height: 100px;" /></a>
<p class="caption"><span class="caption-text">Where system diagrams meet system reality</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
</div>
<div class="admonition-todo admonition" id="id1">
<p class="admonition-title">Todo</p>
<p>Add instructions for user to provide feedback</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an initial draft that likely contains typos, and will likely change.
If you do find an issue, or would like to suggest a change, then submit an issue on Todo</p>
</div>
<div class="admonition-todo admonition" id="id2">
<p class="admonition-title">Todo</p>
<p>this link causes link error to fail : false positive
masteringbusinessanalysis.com/mba084-agile-modeling-with-scott-ambler/ causes link check errors but link is fine
.. _AgileModeling: bit.ly/367B4OK</p>
</div>
<div class="section" id="imagine">
<h2>Imagine<a class="headerlink" href="#imagine" title="Permalink to this headline">¶</a></h2>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Imagine being able to</p>
<ol class="arabic simple">
<li><p>share a model or diagram between all members of the team that they can all understand and contribute to and edit</p></li>
<li><p>draw diagrams like below automatically from a text description.</p></li>
<li><p>describe a system before you build it, when you’re building it, and as you maintain it into the future - keeping the description and the system current and in sync.</p></li>
<li><p>maintain that text version in a source code repository beside the code for the system it is describing</p></li>
</ol>
<p>Imagine having a diagramming tool that</p>
<ol class="arabic simple">
<li><p>fits with a developer workflow, and developers are comfortable using</p></li>
<li><p>enables <strong>lightweight just-enough</strong> <a href="#id5"><span class="problematic" id="id6">AgileModeling_</span></a> in a way that meets <a class="reference external" href="https://tdan.com/best-practices-for-agile-documentation/18936">AgileModelingBP</a></p></li>
<li><p>fits with modern practices of Continuous Integration Continuous Delivery - and “everything as code” including diagrams.</p></li>
</ol>
<p>Well that’s what PlantUML gives you, and more…</p>
</div>
<!DOCTYPE html>
<html>
<head>
<style>
div.gallery {
border: 1px solid #ccc;
}
div.gallery:hover {
border: 1px solid #777;
}
div.gallery img {
width: 100%;
height: auto;
}
div.desc {
padding: 15px;
text-align: center;
}
* {
box-sizing: border-box;
}
.responsive {
padding: 0 6px;
float: left;
width: 24.99999%;
}
@media only screen and (max-width: 700px) {
.responsive {
width: 49.99999%;
margin: 6px 0;
}
}
@media only screen and (max-width: 500px) {
.responsive {
width: 100%;
}
}
.clearfix:after {
content: "";
display: table;
clear: both;
}
</style>
</head>
<body>
<h3>Some Examples</h3>
<div class="responsive">
<div class="gallery">
<a target="_blank" href="networkusers.png">
<img src="networkusers.png" alt="Network Users" width="600" height="400">
</a>
<div class="desc">Uses PlantUML Stdlib OSA icons as described here TODO. insert link to puml file</div>
</div>
</div>
<div class="responsive">
<div class="gallery">
<a target="_blank" href="networkusers.png">
<img src="networkusers.png" alt="Network Users" width="600" height="400">
</a>
<div class="desc">Uses PlantUML Stdlib OSA icons as described here TODO. insert link to puml file</div>
</div>
</div>
<div class="responsive">
<div class="gallery">
<a target="_blank" href="networkusers.png">
<img src="networkusers.png" alt="Network Users" width="600" height="400">
</a>
<div class="desc">Uses PlantUML Stdlib OSA icons as described here TODO. insert link to puml file</div>
</div>
</div>
<div class="responsive">
<div class="gallery">
<a target="_blank" href="networkusers.png">
<img src="networkusers.png" alt="Network Users" width="600" height="400">
</a>
<div class="desc">Uses PlantUML Stdlib OSA icons as described here TODO. insert link to puml file</div>
</div>
</div>
<div class="clearfix"></div>
<div style="padding:6px;">
<p>See more examples in Showcase and RealworldPlantuml</p>
</div>
</body>
</html><div class="admonition-todo admonition" id="id3">
<p class="admonition-title">Todo</p>
<p>include extract from about plantuml chapter</p>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="AboutPlantUML.html">1. About PlantUML</a></li>
<li class="toctree-l1"><a class="reference internal" href="AboutThisGuide.html">2. About this Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="AboutThisGuide.html#goals">2.1. Goals</a></li>
<li class="toctree-l2"><a class="reference internal" href="AboutThisGuide.html#guide-principles">2.2. Guide Principles</a></li>
<li class="toctree-l2"><a class="reference internal" href="AboutThisGuide.html#this-guide">2.3. This Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="AboutThisGuide.html#credits">2.4. Credits</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Stdlib</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html">1. Plantuml Sprites</a><ul>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#builtin-sprites-deployment-diagram-sprites">1.1. Builtin Sprites - Deployment Diagram Sprites</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#builtin-sprites-standard-library-sprites">1.2. Builtin Sprites - Standard Library Sprites</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#create-a-sprite">1.3. Create a Sprite</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#create-sprites-by-converting-osa-icon-libaries">1.4. Create Sprites by converting OSA icon libaries</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/plantuml_sprites.html#plantuml-hyperlinks">1.5. PlantUML HyperLinks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="PlantUMLSpriteLibraries/PlantUMLSprites.html">2. Understanding PlantUML Stdlib Sprite Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/PlantUMLSprites.html#goal">2.1. Goal</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/PlantUMLSprites.html#example-puml-file-from-plantuml-stdlib">2.2. Example Puml file from PlantUML Stdlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="PlantUMLSpriteLibraries/PlantUMLSprites.html#steps-to-understanding">2.3. Steps to Understanding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html">3. Create a Diagram of a Typical Network</a><ul>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#example-network-diagram">3.1. Example Network Diagram</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#select-an-icon-library">3.2. Select an icon library</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#view-all-the-icons-with-listsprites">3.3. View all the icons with listsprites</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#gather-the-icons-we-need">3.4. Gather the icons we need</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#decorate-the-icons">3.5. Decorate the Icons</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#create-the-diagram-by-connecting-things-together">3.6. Create the diagram by connecting things together</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#change-the-layout-to-vertical">3.7. Change the Layout to Vertical</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#change-the-layout-by-grouping-icons-together">3.8. Change the Layout by grouping icons together</a></li>
<li class="toctree-l2"><a class="reference internal" href="NetworkUsersMachines/NetworkUsersMachines.html#conclusion">3.9. Conclusion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="PassSpriteAsParameter/PassSpriteAsParameter.html">4. Create a Template from our Network Diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/StandardisingSrdLib.html">5. StandardisingStdLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib/ContributingToStdlib.html">6. ContributingToStdlib</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">C4</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="C4/C4Stdlib.html">1. Using PlantUML Stdlib C4 Lightweight Software Architecture Description Method</a><ul>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4">1.1. C4</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4-plantuml">1.2. C4 PlantUML</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4-example-big-bank">1.3. C4 Example Big Bank</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/C4Stdlib.html#c4-acme-global-widget-production">1.4. C4 ACME Global Widget Production</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">New ways to Run PlantUML</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="GenerateDiagrams/GenerateDiagrams.html">1. Generate diagrams from PlantUML source files using GithubActions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="GenerateDiagrams/GenerateDiagrams.html#github-actions">1.1. Github Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="GenerateDiagrams/GenerateDiagrams.html#plantuml-github-action">1.2. PlantUML GitHub action</a></li>
<li class="toctree-l2"><a class="reference internal" href="GenerateDiagrams/GenerateDiagrams.html#conclusion">1.3. Conclusion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="GenerateDiagrams/GenerateDiagramsLambda.html">2. Generate diagrams from PlantUML source files using AWS Lambda</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Annex</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="C4/c4.html">1. C4 Lightweight Software Architecture Description Method</a><ul>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#introduction">1.1. Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#cheatsheet">1.2. CheatSheet</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#video-presentation">1.3. Video Presentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="C4/c4.html#related-methods">1.4. Related Methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="DocumentationAsCode/JourneyDocumentationASCode.html">2. Journey to Documentation as Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="DocumentationAsCode/JourneyDocumentationASCode.html#my-view-on-documenation-from-2013">2.1. My View On Documenation From 2013</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">ToDo</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="todo.html">1. To Do List</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="AboutPlantUML.html" class="btn btn-neutral float-right" title="1. About PlantUML" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>