1. Context

1.1. Business Context

Business Context
Figure 1. Business Context
Table 1. Business Context
Neighbor Description

user

documents software with toolchain that generates html. Wants to ensure that links within this html are valid.

build system

local html files

HtmlSC reads and parses local html files and performs sanity checks within those.

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. Due to the nature of web systems, this check might need a significant amount of time and might yield invalid results due to network and latency issues.

1.2. Deployment Context

The following diagram shows the participating computers ({node}) with their technical connections plus the major {artifact} of HtmlSC, the hsc-plugin-binary.

Deployment Context
Figure 2. Deployment Context
Table 2. Deployment Context
Node / Artifact Description

{node} hsc-development

where development of HtmlSC takes place

{artifact} hsc-plugin-binary

compiled and packaged version of HtmlSC including required dependencies.

{node} artifact repository (Bintray)

global public cloud repository for binary artifacts, similar to mavenCentral. HtmlSC binaries are uploaded to this server.

{node} hsc user computer

where arbitrary documentation takes place with html as output formats.

{artifact} build.gradle

Gradle build script configuring (among other things) the HtmlSC plugin to perform the Html checking.

Details see deployment view.