Skip to content

Commit bc9ac58

Browse files
thecodingdoc1thecodingdoc1
committed
update
2 parents 128d37e + f4a3d5f commit bc9ac58

19 files changed

+679
-249
lines changed

‎Jenkinsfile

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,51 +7,72 @@ def notifyBranch = [recipients: [brokenTestsSuspects(), requestor()]]
77
pipeline {
88
agent {
99
node {
10-
label 'alpine:mkdocs'
11-
customWorkspace workspace().getUniqueWorkspacePath()
10+
label 'alpine-mkdocs'
1211
}
1312
}
1413
environment {
15-
DEPLOY_URL="https://strongbox.github.io"
14+
DEPLOY_URL = "https://strongbox.github.io"
1615
}
1716
options {
1817
timeout(time: 30, unit: 'MINUTES')
18+
disableConcurrentBuilds()
1919
}
2020
stages {
21-
stage('Node')
22-
{
21+
stage('Node') {
2322
steps {
24-
nodeInfo("python pip mkdocs")
23+
container("mkdocs") {
24+
nodeInfo("python pip mkdocs")
25+
}
2526
}
2627
}
27-
stage('Building')
28-
{
28+
stage('Building') {
2929
steps {
30-
withCredentials([string(credentialsId: '3ea1e18a-b1d1-44e0-a1ff-7b62870913f8', variable: 'GOOGLE_ANALYTICS_KEY')]) {
31-
sh "mkdocs build"
30+
container("mkdocs") {
31+
withCredentials([string(credentialsId: '3ea1e18a-b1d1-44e0-a1ff-7b62870913f8', variable: 'GOOGLE_ANALYTICS_KEY')]) {
32+
sh "mkdocs build"
33+
}
3234
}
3335
}
3436
}
3537
stage('Deploying') {
3638
when {
37-
expression { BRANCH_NAME == 'master' && (currentBuild.result == null || currentBuild.result == 'SUCCESS') }
39+
expression {
40+
BRANCH_NAME == 'master' && (currentBuild.result == null || currentBuild.result == 'SUCCESS')
41+
}
3842
}
3943
steps {
40-
configFileProvider([configFile(fileId: 'e0235d92-c2fc-4f81-ae4b-28943ed7350d', targetLocation: '/tmp/gh-pages.sh')]) {
44+
container("mkdocs") {
4145
withCredentials([sshUserPrivateKey(credentialsId: '011f2a7d-2c94-48f5-92b9-c07fd817b4be', keyFileVariable: 'SSH_KEY', usernameVariable: 'SSH_USER')]) {
4246
withEnv(["GIT_SSH_COMMAND=ssh -o StrictHostKeyChecking=no -o User=${SSH_USER} -i ${SSH_KEY}"]) {
43-
sh "/bin/bash /tmp/gh-pages.sh"
47+
sh 'git checkout --orphan gh-pages'
48+
sh 'find . -maxdepth 1 ! -name "site" ! -name ".git*" ! -name "." -exec git rm -rf {} \\;'
49+
sh 'git add --force site'
50+
sh 'git commit -m "Updating documentation site."'
51+
sh 'git remote add strongbox.github.io [email protected]:strongbox/strongbox.github.io.git'
52+
sh 'git push strongbox.github.io `git subtree split --prefix site gh-pages`:master --force'
4453
}
4554
}
4655
}
4756
}
4857
}
4958
}
5059
post {
51-
cleanup {
60+
failure {
5261
script {
53-
workspace().clean()
62+
if (params.NOTIFY_EMAIL)
63+
{
64+
notifyFailed((BRANCH_NAME == "master") ? notifyMaster : notifyBranch)
65+
}
66+
}
67+
}
68+
fixed {
69+
script {
70+
if (params.NOTIFY_EMAIL)
71+
{
72+
notifyFixed((BRANCH_NAME == "master") ? notifyMaster : notifyBranch)
73+
}
5474
}
5575
}
5676
}
5777
}
78+

‎docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: '3'
22
services:
33
mkdocs:
4-
image: strongboxci/alpine:mkdocs-4.0
4+
image: strongboxci/alpine:mkdocs-4.4
55
volumes:
66
- ./:/docs
77
ports:

‎docs/assets/resources/maven/settings-local.xml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<settings>
3+
4+
<localRepository>.m2/repository-strongbox-local</localRepository>
5+
6+
<mirrors>
7+
<mirror>
8+
<id>strongbox</id>
9+
<name>strongbox</name>
10+
<url>http://localhost:48080/storages/public/maven-group/</url>
11+
<mirrorOf>*</mirrorOf>
12+
</mirror>
13+
</mirrors>
14+
15+
<profiles>
16+
<profile>
17+
<id>carlspring-repositories</id>
18+
19+
<activation>
20+
<activeByDefault>true</activeByDefault>
21+
</activation>
22+
23+
<repositories>
24+
<repository>
25+
<id>strongbox</id>
26+
<name>strongbox</name>
27+
<url>http://localhost:48080/storages/public/maven-group/</url>
28+
<layout>default</layout>
29+
</repository>
30+
</repositories>
31+
<pluginRepositories>
32+
<pluginRepository>
33+
<id>strongbox</id>
34+
<name>strongbox</name>
35+
<url>http://localhost:48080/storages/public/maven-group/</url>
36+
<layout>default</layout>
37+
</pluginRepository>
38+
</pluginRepositories>
39+
</profile>
40+
</profiles>
41+
42+
<servers>
43+
<server>
44+
<id>releases</id>
45+
<username>admin</username>
46+
<password>password</password>
47+
</server>
48+
<server>
49+
<id>snapshots</id>
50+
<username>admin</username>
51+
<password>password</password>
52+
</server>
53+
</servers>
54+
</settings>

‎docs/assets/stylesheets/style.css

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,103 @@ body > .md-container {
1212
color: rgba(255, 255, 255, 0.9);
1313
}
1414

15+
.md-typeset .admonition.hint,
16+
.md-typeset .admonition.important,
17+
.md-typeset .admonition.tip,
18+
.md-typeset details.hint,
19+
.md-typeset details.important,
20+
.md-typeset details.tip {
21+
border-top-color: #00bfa5;
22+
}
23+
24+
.md-typeset .admonition.attention, .md-typeset .admonition.caution, .md-typeset .admonition.warning, .md-typeset details.attention, .md-typeset details.caution, .md-typeset details.warning {
25+
border-top-color: #ff9100;
26+
}
27+
28+
.md-typeset .admonition, .md-typeset details {
29+
border-top: .068rem solid #448aff
30+
}
31+
32+
.md-typeset {
33+
/* break extra long headers */
34+
overflow-wrap: break-word;
35+
}
36+
1537
.md-typeset h1,
1638
.md-typeset h2,
1739
.md-typeset h3,
1840
.md-typeset h4,
1941
.md-typeset h5,
2042
.md-typeset h6 {
2143
color: white;
44+
font-weight: 300;
45+
}
46+
47+
.md-typeset h2,
48+
.md-typeset h3,
49+
.md-typeset h4,
50+
.md-typeset h5,
51+
.md-typeset h6 {
52+
margin: 2rem 0 0.4rem;
53+
}
54+
55+
.md-typeset h1 {
56+
margin: 0 0 0.4rem;
57+
}
58+
59+
.md-typeset h2:first-child,
60+
.md-typeset h3:first-child,
61+
.md-typeset h4:first-child,
62+
.md-typeset h5:first-child,
63+
.md-typeset h6:first-child {
64+
margin: 0.8rem 0 0.4rem;
65+
}
66+
67+
.md-typeset h1 + h2,
68+
.md-typeset h1 + h3,
69+
.md-typeset h1 + h4,
70+
.md-typeset h1 + h5,
71+
.md-typeset h1 + h6,
72+
.md-typeset h2 + h2,
73+
.md-typeset h2 + h3,
74+
.md-typeset h2 + h4,
75+
.md-typeset h2 + h5,
76+
.md-typeset h2 + h6,
77+
.md-typeset h3 + h3,
78+
.md-typeset h3 + h4,
79+
.md-typeset h3 + h5,
80+
.md-typeset h3 + h6,
81+
.md-typeset h4 + h4,
82+
.md-typeset h4 + h4,
83+
.md-typeset h4 + h5,
84+
.md-typeset h5 + h5,
85+
.md-typeset h5 + h6,
86+
.md-typeset h6 + h6 {
87+
margin: 0.8rem 0 0.4rem !important;
88+
}
89+
90+
.md-typeset h1 {
91+
font-size: 1.8rem;
92+
}
93+
94+
.md-typeset h2 {
95+
font-size: 1.6rem;
96+
}
97+
98+
.md-typeset h3 {
99+
font-size: 1.34rem;
100+
}
101+
102+
.md-typeset h4 {
103+
font-size: 1.22rem;
104+
}
105+
106+
.md-typeset h5 {
107+
font-size: 1.18rem;
108+
}
109+
110+
.md-typeset h6 {
111+
font-size: 1.1rem;
22112
}
23113

24114
[data-md-color-primary=blue-grey] .md-typeset a {
@@ -101,12 +191,28 @@ body > .md-container {
101191
background-color: hsla(343, 100%, 31%, 0.3)
102192
}
103193

194+
.md-typeset table:not([class]) {
195+
border: 1px solid rgba(0,0,0,0.3);
196+
}
197+
104198
.md-typeset table:not([class]) th {
105199
background-color: rgba(0,0,0,0.3);
200+
vertical-align: middle;
201+
}
202+
203+
.md-typeset table:not([class]) tr:hover {
204+
box-shadow: none;
205+
}
206+
207+
.md-typeset table:not([class]) td {
208+
border-top: 0px !important;
106209
}
107210

108211
.md-typeset .md-typeset__table {
109212
width: 100%;
213+
display: block;
214+
box-shadow: 0 2px 2px 0 rgba(0,0,0,.14), 0 1px 5px 0 rgba(0,0,0,.12), 0 3px 1px -2px rgba(0,0,0,.2);
215+
110216
}
111217

112218
@media only screen and (max-width: 76.1875em)
@@ -262,3 +368,6 @@ html .md-typeset .env details > :last-child {
262368
object-fit: cover;
263369
}
264370

371+
.hidden {
372+
display: none;
373+
}

‎docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ failing tests. In case of issues (i.e. build failures), please ping us in the ch
5252
Please continue reading our [CONTRIBUTING.md](https://github.com/strongbox/strongbox/blob/master/CONTRIBUTING.md).
5353

5454
!!! warning
55-
For legal reasons we will request you to sign our <a href="/assets/resources/pdfs/ICLA.pdf" target="_blank">ICLA</a> before we can merge your
55+
For legal reasons we will request you to sign our <a href="{{resources}}/pdfs/ICLA.pdf" target="_blank">ICLA</a> before we can merge your
5656
pull request. The collected information is in no way provided to third-party companies nor anybody else.
5757

5858
**Refusing to sign the ICLA will leave us with no other choice but to close any pull request you might have opened.**

‎docs/developer-guide/logging.md renamed to ‎docs/developer-guide/add-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Logging
1+
# Add logging to projects or modules
22

33
The logging in the application is set up using:
44

0 commit comments

Comments
 (0)