Skip to content

Commit 2356e87

Browse files
hohwillehohwille
committed
added POMs to build PDF
1 parent 5ee0a0d commit 2356e87

File tree

4 files changed

+98
-5
lines changed

4 files changed

+98
-5
lines changed

‎documentation/deployment-management.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Shutting down servers or starting schema migrations are typical manual tasks.
4343
=== Master the artefact dependencies
4444
Explicitly track and resolve the transitive run-time dependencies between deployment artefacts to ensure a transparent and traceable installation.
4545

46-
First, clearly distinguish between build-time, test, and run-time dependencies, as they typically have to be resolved at different times (build versus deployment), and plain build-time or test dependencies shall not be included in the release package. Refer to the pattern \ref{pat:CheckDependencies} for further details with reference to this issue.
46+
First, clearly distinguish between build-time, test, and run-time dependencies, as they typically have to be resolved at different times (build versus deployment), and plain build-time or test dependencies shall not be included in the release package.
4747

4848
=== Separate environments
4949
Separate environments for development, test, acceptance, and production (DTAP):
@@ -85,7 +85,7 @@ The reason is that service windows of operations and the domain-related business
8585
All operation departments have regulations on how to deploy software systems and what are the preconditions to deploy them into production.
8686
This includes, for example, that the new software has to support specialised monitoring or logging features, or that it must offer some dictated services, for shutting down or starting the server process.
8787

88-
Hence, for every smooth \textit{going live} process, you must always ensure that the deployment is truly performed hand-in-hand with these stakeholders.
88+
Hence, for every smooth _going live_ process, you must always ensure that the deployment is truly performed hand-in-hand with these stakeholders.
8989
This involves clearly communicating what version is being deployed, when it is deployed, why it is deployed, what user-visible changes will be apparent subsequently, etc.
9090

9191
=== Make and follow a detailed deployment plan

‎documentation/pom.xml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
4+
<modelVersion>4.0.0</modelVersion>
5+
<parent>
6+
<groupId>com.devonfw.tools</groupId>
7+
<artifactId>devonfw-docgen-pdf</artifactId>
8+
<version>2021.04.001</version>
9+
<relativePath></relativePath>
10+
</parent>
11+
<groupId>com.devonfw.doc</groupId>
12+
<artifactId>scm-doc</artifactId>
13+
<version>${revision}</version>
14+
<packaging>pom</packaging>
15+
<name>${project.artifactId}</name>
16+
<description>The devonfw documentation about software-configuration-management (scm).</description>
17+
18+
<properties>
19+
<docgen.asciidoc.page>scm</docgen.asciidoc.page>
20+
<revision>dev-SNAPSHOT</revision>
21+
</properties>
22+
23+
<!-- run "mvn package" and get the PDF result in target/generated-docs/*.pdf -->
24+
25+
</project>

‎documentation/scm.asciidoc

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,29 @@
1-
:toc: macro
2-
toc::[]
3-
41
= Software-Configuration-Management
2+
:description: comprehensive documentation about software-configuration-management.
3+
:doctype: book
4+
:toc:
5+
:toc-title: Table of Contents
6+
:idprefix:
7+
:idseparator: -
8+
:sectnums:
9+
:reproducible:
10+
:source-highlighter: rouge
11+
:listing-caption: Listing
12+
:chapter-label:
13+
:partnums:
14+
:imagesdir: ./
15+
The devonfw community
16+
${project.version}, ${buildtime}
17+
518

619
_Software-configuration-management (SCM) is the application of configuration management principles in the context of software engineering_.
720

821
SCM identifies and tracks the configuration of artifacts at various points in time and performs systematic control of changes to the configuration of artifacts for the purpose of maintaining integrity and traceability throughout the whole software development lifecycle.
922

23+
The following sections contain the complete compendium of https://github.com/devonfw/scm/[software-configuration-management] (SCM).
24+
You can also read the latest version of this documentation online in the http://github.com/devonfw/scm/wiki[scm wiki]
25+
or at https://devonfw.com/website/pages/docs/scm.asciidoc.html[scm on devonfw.com].
26+
1027
image::images/scm.png["software-configuration-management model",scaledwidth="80%",align="center",link="https://raw.githubusercontent.com/devonfw/scm/master/documentation/images/scm.svg"]
1128

1229
Please click on the SCM model image to open it as SVG and click on the domains and disciplines topics to open the according documentation.
@@ -18,3 +35,29 @@ Software-configuration-management consists of the following domains:
1835
* link:release-and-change.asciidoc[release & change]
1936
* link:build-and-deployment.asciidoc[build & deployment]
2037
* link:configuration.asciidoc[configuration]
38+
39+
include::build-and-deployment.asciidoc[leveloffset=1]
40+
41+
include::build-management.asciidoc[leveloffset=1]
42+
43+
include::deployment-management.asciidoc[leveloffset=1]
44+
45+
<<<<
46+
47+
include::configuration.asciidoc[leveloffset=1]
48+
49+
include::version-identification.asciidoc[leveloffset=1]
50+
51+
include::version-control.asciidoc[leveloffset=1]
52+
53+
include::artifact-management.asciidoc[leveloffset=1]
54+
55+
include::issue-tracking.asciidoc[leveloffset=1]
56+
57+
<<<<
58+
59+
include::release-and-change.asciidoc[leveloffset=1]
60+
61+
include::release-management.asciidoc[leveloffset=1]
62+
63+
include::change-request-management.asciidoc[leveloffset=1]

‎pom.xml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
<modelVersion>4.0.0</modelVersion>
5+
<parent>
6+
<groupId>com.devonfw</groupId>
7+
<artifactId>maven-parent</artifactId>
8+
<version>6</version>
9+
</parent>
10+
<groupId>com.devonfw.doc</groupId>
11+
<artifactId>scm</artifactId>
12+
<version>dev-SNAPSHOT</version> <!-- This POM will never be released -->
13+
<packaging>pom</packaging>
14+
<name>${project.artifactId}</name>
15+
<description>The devonfw best-practices about software-configuration-management (scm).</description>
16+
17+
<modules>
18+
<module>documentation</module>
19+
</modules>
20+
21+
<properties>
22+
<revision>dev-SNAPSHOT</revision>
23+
<github.repository>scm</github.repository>
24+
</properties>
25+
</project>

0 commit comments

Comments
 (0)