yamcs.github.com/tag-document-version.sh at jekyll · m-sc/yamcs.github.com · GitHub

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
#!/bin/bash

# 1) Copy guide from /_data/sidebar/guides/<document>.yaml to /_data/sidebar/guides/<document>_<version_escaped>.yaml
# 2) copy files from /docs/<document>/* to /docs/history/<document>/<version>/
# Next steps are from folder /docs/history/<document>/<version>/
# 3) Edit index.html to:
#    - in header, modify pdf link to /assets/pdf/<doc_title>-<version>.pdf
#    - in body, append <version_escaped> to {% include toc.html structure=site.data.sidebar.guides.[...]
# 4) Edit all files header to:
#    - insert version in permalink
#    - add version tag
# 5) Edit pdf/*.md to:
#    - insert version in permalink
# 6) Edit pdf/content.md file header to:
#    - append _<version_escaped> to tag guide
# 7) Update /doc/<document>/index.html and /docs/history/<document>/*/index.html to:
#    - add <version> to tag "previousVersions"
# 8) Wait for jekkyl to update website (arbitrary 20 s), then generate PDF of <document> <version>


document=$1
version=$2
version_escaped=${version//[.]/_}

if [ -z "$document" ] || [ -z "$version" ]; then
echo "usage: ./tag-document-version.sh <document> <version>, with <document> one of [server, studio, tools]."
exit
fi

echo updating website, document: $document , version: $version
#1)
cp _data/sidebar/guides/$document.yaml _data/sidebar/guides/${document}_$version_escaped.yaml
sed -i "s/docs\/$document/docs\/$document\/$version/g" _data/sidebar/guides/${document}_$version_escaped.yaml

#2)
mkdir -p docs/history/$document/$version/
cp -r docs/$document/* docs/history/$document/$version/

#3)
sed -i "s/.pdf/-$version.pdf/g" docs/history/$document/$version/index.html
sed -i "s/structure=site.data.sidebar.guides.$document/structure=site.data.sidebar.guides.${document}_$version_escaped/g" docs/history/$document/$version/index.html

#4)
sed -i "s/permalink:/version: $version\npermalink:/g" docs/history/$document/$version/*.*
sed -i "s/permalink: \/docs\/$document/permalink: \/docs\/$document\/$version/g" docs/history/$document/$version/*.*

#5)
sed -i "s/permalink: \/docs\/$document/permalink: \/docs\/$document\/$version/g" docs/history/$document/$version/pdf/*

#6)
sed -i "s/guide: $document/guide: ${document}_$version_escaped/g" docs/history/$document/$version/pdf/content.md

#7)
./update-version-history.sh docs/$document/index.html $version
find docs/history/$document -name index.html -exec sh -c "./update-version-history.sh {} $version" {} \;

#8)
read -n1 -r -p "Waiting for jekyll to update the website, press any key to start PDF file generation..." key
./make-pdf.sh $document $version