From 81ad6856c733cea66888964f857606a22df5fa7e Mon Sep 17 00:00:00 2001 From: Per Starke Date: Fri, 7 Jun 2024 09:08:50 +0200 Subject: [PATCH 1/2] start trying examples as nutshell --- _examples/03-context-example-business-1.md | 6 ++++-- _examples/03-context-example-business-2.md | 3 ++- _examples/03-context-example-business-3.md | 3 ++- _examples/03-context-example-technical-1.md | 3 ++- _examples/03-context-example-technical-4.md | 3 ++- _includes/example-header.html | 2 +- _layouts/default.html | 1 + _pages/section-3.md | 2 +- 8 files changed, 15 insertions(+), 8 deletions(-) diff --git a/_examples/03-context-example-business-1.md b/_examples/03-context-example-business-1.md index 5965bdb..68fbfca 100644 --- a/_examples/03-context-example-business-1.md +++ b/_examples/03-context-example-business-1.md @@ -6,7 +6,9 @@ category: business-context permalink: /examples/business-context-1/ --- -
+ +
+
This is a very simple example, created with Enterprise Architect(TM).
@@ -26,4 +28,4 @@ This is a very simple example, created with Enterprise Architect(TM). |local image files |HtmlSC checks if linked images exist as (local) files. | |------|---------| |external web resources |HtmlSC can be configured to optionally check for the existence of external web resources. -**Risk**: Due to the nature of web systems and the involved remote network operations, this check might need significant time and might yield invalid results due to network and latency issues. | \ No newline at end of file +**Risk**: Due to the nature of web systems and the involved remote network operations, this check might need significant time and might yield invalid results due to network and latency issues. | diff --git a/_examples/03-context-example-business-2.md b/_examples/03-context-example-business-2.md index 47a2266..8c57021 100644 --- a/_examples/03-context-example-business-2.md +++ b/_examples/03-context-example-business-2.md @@ -6,7 +6,8 @@ category: business-context permalink: /examples/context-business-2/ --- -
+
+
A simple diagram with a brief explanation in a table.
diff --git a/_examples/03-context-example-business-3.md b/_examples/03-context-example-business-3.md index 6496cd1..2c8e5d1 100644 --- a/_examples/03-context-example-business-3.md +++ b/_examples/03-context-example-business-3.md @@ -6,7 +6,8 @@ category: business-context permalink: /examples/business-context-3/ --- -
+
+
This example has been created with Enterprise Architect(TM) as a data flow diagram.
diff --git a/_examples/03-context-example-technical-1.md b/_examples/03-context-example-technical-1.md index b455d22..075c441 100644 --- a/_examples/03-context-example-technical-1.md +++ b/_examples/03-context-example-technical-1.md @@ -6,7 +6,8 @@ category: technical-context permalink: /examples/technical-context-1/ --- -
+
+
This is a very simple example, created with Enterprise Architect(TM).
diff --git a/_examples/03-context-example-technical-4.md b/_examples/03-context-example-technical-4.md index 900e248..1d16938 100644 --- a/_examples/03-context-example-technical-4.md +++ b/_examples/03-context-example-technical-4.md @@ -6,7 +6,8 @@ category: technical-context permalink: /examples/technical-context-4/ --- -
+
+
This example has been created with Enterprise Architect(TM) as a deployment model.
diff --git a/_includes/example-header.html b/_includes/example-header.html index 7b06191..e2df862 100755 --- a/_includes/example-header.html +++ b/_includes/example-header.html @@ -2,7 +2,7 @@
  • {% if include.link %} - {{ page.title }} + :{{ page.title }} {% else %} {{ page.title }} {% endif %} diff --git a/_layouts/default.html b/_layouts/default.html index 1cfa120..087ebe3 100755 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -4,6 +4,7 @@ {% capture title %}{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}{% endcapture %} {% seo %} + {% include page-url-resolver.html page=page %} {% if page.excerpt %} {% assign description = page.excerpt | strip_html | strip_newlines | truncate: 160 %} diff --git a/_pages/section-3.md b/_pages/section-3.md index 785670f..1f7226c 100755 --- a/_pages/section-3.md +++ b/_pages/section-3.md @@ -27,7 +27,7 @@ your system's most critical aspects. Make sure that you completely understand th See below, separated into business- and technical context.
    • - + ### 3.1 Business context
    From 479ebf1c217174d9768483db85003ec487dee8a9 Mon Sep 17 00:00:00 2001 From: Per Starke Date: Sat, 8 Jun 2024 13:20:11 +0200 Subject: [PATCH 2/2] update examples for nutshell --- _examples/01-overview-example-3.md | 3 ++- _examples/01-overview-example-htmlsc-1.md | 5 +++-- _examples/01-quality-reqs-example-1.md | 3 ++- _examples/01-quality-reqs-example-3.md | 5 +++-- _examples/02-constraint-example-1.md | 3 ++- _examples/04-solutionStrategy-example-htmlsc-1.md | 5 +++-- _examples/04-solutionStrategy-example-mama-2.md | 5 +++-- _examples/05-buildingblock-example-hsc.md | 3 ++- _examples/05-buildingblock-example-tpu-lev-1.md | 3 ++- _examples/05-buildingblock-example-tpu-lev-2.md | 3 ++- _examples/06-runtime-example-htmlsc-1.md | 3 ++- _examples/06-runtime-example-mama-2.md | 5 ----- _examples/06-runtime-example-tpu-1.md | 3 ++- _examples/07-deployment-example-tpu-1.md | 3 ++- _examples/07-deployment-sample-tpu-2.md | 3 ++- _examples/12-glossary-example-htmlsc-1.md | 3 ++- 16 files changed, 34 insertions(+), 24 deletions(-) diff --git a/_examples/01-overview-example-3.md b/_examples/01-overview-example-3.md index 986c4ea..68303cd 100644 --- a/_examples/01-overview-example-3.md +++ b/_examples/01-overview-example-3.md @@ -6,7 +6,8 @@ category: overview permalink: /examples/overview-example-3/ --- -
    +
    +
    After a short introductory text explaining the system under design a table of key project goals is given and an overview of the functionality is shown as use case diagram with accompaning table
    diff --git a/_examples/01-overview-example-htmlsc-1.md b/_examples/01-overview-example-htmlsc-1.md index 5304de6..cb671ea 100644 --- a/_examples/01-overview-example-htmlsc-1.md +++ b/_examples/01-overview-example-htmlsc-1.md @@ -6,8 +6,9 @@ category: overview permalink: /examples/overview-example-htmlsc-1/ --- -
    -The _HTML Sanity Checker_ is an extremely simple and small system. +
    +
    +The HTML Sanity Checker is an extremely simple and small system. The overview is given as informal diagram with a brief textual explanation.
    diff --git a/_examples/01-quality-reqs-example-1.md b/_examples/01-quality-reqs-example-1.md index 77370f3..b03ec90 100644 --- a/_examples/01-quality-reqs-example-1.md +++ b/_examples/01-quality-reqs-example-1.md @@ -6,7 +6,8 @@ category: quality-goals permalink: /examples/quality-requirements-1/ --- -
    +
    +
    This example has been created with Enterprise Architect(TM) as a data flow diagram.
    diff --git a/_examples/01-quality-reqs-example-3.md b/_examples/01-quality-reqs-example-3.md index f43886e..b7ee51b 100644 --- a/_examples/01-quality-reqs-example-3.md +++ b/_examples/01-quality-reqs-example-3.md @@ -6,8 +6,9 @@ category: quality-goals permalink: /examples/quality-requirements-3/ --- -
    -We have used a table with categories and detailed decriptions for the top-3 quality goals. More quality requirements can be found in section 10. +
    +
    +We have used a table with categories and detailed descriptions for the top-3 quality goals. More quality requirements can be found in section 10.
    diff --git a/_examples/02-constraint-example-1.md b/_examples/02-constraint-example-1.md index 03271df..64b21aa 100644 --- a/_examples/02-constraint-example-1.md +++ b/_examples/02-constraint-example-1.md @@ -6,7 +6,8 @@ category: constraints permalink: /examples/constraints-1/ --- -
    +
    +
    Key constraints can often be explained as simple enumeration in plain text.
    diff --git a/_examples/04-solutionStrategy-example-htmlsc-1.md b/_examples/04-solutionStrategy-example-htmlsc-1.md index f11a4a0..41c82d3 100644 --- a/_examples/04-solutionStrategy-example-htmlsc-1.md +++ b/_examples/04-solutionStrategy-example-htmlsc-1.md @@ -7,10 +7,11 @@ permalink: /examples/solution-strategy-htmlsc-1/ --- -
    +
    +
    You need a brief summary and explanation of the fundamental solution ideas and strategies. These key ideas should be familiar to everyone involved in development and architecture. - +
    Briefly explain how you achieve the most important quality requirements.
    diff --git a/_examples/04-solutionStrategy-example-mama-2.md b/_examples/04-solutionStrategy-example-mama-2.md index 927afb6..5f75649 100644 --- a/_examples/04-solutionStrategy-example-mama-2.md +++ b/_examples/04-solutionStrategy-example-mama-2.md @@ -6,10 +6,11 @@ category: solutionstrategy permalink: /examples/solution-strategy-mama-2/ --- -
    +
    +
    You need a brief summary and explanation of the fundamental solution ideas and strategies. These key ideas should be familiar to everyone involved in development and architecture. - +
    Briefly explain how you achieve the most important quality requirements.
    diff --git a/_examples/05-buildingblock-example-hsc.md b/_examples/05-buildingblock-example-hsc.md index 9de3714..d08d4bb 100644 --- a/_examples/05-buildingblock-example-hsc.md +++ b/_examples/05-buildingblock-example-hsc.md @@ -7,7 +7,8 @@ permalink: /examples/buildingblock-hsc/ --- -
    +
    +
    This example contains several levels of the building block view - ranging from the overview level-1 down to very specific and low-level-3.
    diff --git a/_examples/05-buildingblock-example-tpu-lev-1.md b/_examples/05-buildingblock-example-tpu-lev-1.md index a0ef373..2d7f854 100644 --- a/_examples/05-buildingblock-example-tpu-lev-1.md +++ b/_examples/05-buildingblock-example-tpu-lev-1.md @@ -7,7 +7,8 @@ permalink: /examples/buildingblock-tpu-1/ --- -
    +
    +
    This Level 1 diagram has been created with Enterprise Architect(TM) as a component diagram. It is augmented by a list of black box descriptions for each building block.
    diff --git a/_examples/05-buildingblock-example-tpu-lev-2.md b/_examples/05-buildingblock-example-tpu-lev-2.md index ba67bb1..9f188d3 100644 --- a/_examples/05-buildingblock-example-tpu-lev-2.md +++ b/_examples/05-buildingblock-example-tpu-lev-2.md @@ -7,7 +7,8 @@ permalink: /examples/buildingblock-tpu-2/ --- -
    +
    +
    This diagram (created with Enterprise Architect(TM) as a component model) shows the refinement of the measuring box including the level 2 black box descriptions.
    diff --git a/_examples/06-runtime-example-htmlsc-1.md b/_examples/06-runtime-example-htmlsc-1.md index 44c5d98..458d79c 100644 --- a/_examples/06-runtime-example-htmlsc-1.md +++ b/_examples/06-runtime-example-htmlsc-1.md @@ -7,7 +7,8 @@ permalink: /examples/runtime-1/ --- -
    +
    +
    A simple diagram with a brief textual explanation.
    diff --git a/_examples/06-runtime-example-mama-2.md b/_examples/06-runtime-example-mama-2.md index 293d5c8..c811e7d 100644 --- a/_examples/06-runtime-example-mama-2.md +++ b/_examples/06-runtime-example-mama-2.md @@ -6,11 +6,6 @@ category: runtime permalink: /examples/runtime-mama-2/ --- - -
    - -
    - ## 6. Runtime View ### 6.1 Import File diff --git a/_examples/06-runtime-example-tpu-1.md b/_examples/06-runtime-example-tpu-1.md index 8a78ad2..f10e87e 100644 --- a/_examples/06-runtime-example-tpu-1.md +++ b/_examples/06-runtime-example-tpu-1.md @@ -7,7 +7,8 @@ permalink: /examples/runtime-tpu-1/ --- -
    +
    +
    A simple diagram with a brief textual explanation.
    diff --git a/_examples/07-deployment-example-tpu-1.md b/_examples/07-deployment-example-tpu-1.md index 09e8eae..5614519 100644 --- a/_examples/07-deployment-example-tpu-1.md +++ b/_examples/07-deployment-example-tpu-1.md @@ -7,7 +7,8 @@ permalink: /examples/deployment-1/ --- -
    +
    +
    The example shows an Enterprise Architect (TM) deployment diagram to show the processors used to implement the complete functionality of the Traffic Pursuit Unit. Note the design decisions (i.e. the technology) for the channels connecting the processors.
    diff --git a/_examples/07-deployment-sample-tpu-2.md b/_examples/07-deployment-sample-tpu-2.md index afe08b0..194d32e 100644 --- a/_examples/07-deployment-sample-tpu-2.md +++ b/_examples/07-deployment-sample-tpu-2.md @@ -7,7 +7,8 @@ permalink: /examples/deployment-2/ --- -
    +
    +
    The example shows an Enterprise Architect (TM) deployment diagram to show the refinement of one processors.
    diff --git a/_examples/12-glossary-example-htmlsc-1.md b/_examples/12-glossary-example-htmlsc-1.md index a94a741..b8c0410 100644 --- a/_examples/12-glossary-example-htmlsc-1.md +++ b/_examples/12-glossary-example-htmlsc-1.md @@ -5,7 +5,8 @@ tags: glossary example category: glossary permalink: /examples/glossary-1/ --- -
    +
    +
    Here you find an example of a glossary.