From 92333e4d611352cd561a44ccc8cd0a79c84a2b7d Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 10:40:47 +0100 Subject: [PATCH 1/7] new: [build] move from GitBook to honkit (fork of GitBook) --- .travis.yml | 7 ++++--- SUMMARY.md | 14 ++++++++------ book.json | 4 ++-- publish.sh | 10 +++++----- 4 files changed, 19 insertions(+), 16 deletions(-) diff --git a/.travis.yml b/.travis.yml index c82969a..950d2b1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,13 +14,14 @@ install: - sudo n stable - sudo ln -sf /usr/local/n/versions/node/8.0.0/bin/node /usr/bin/node - sudo npm update -g - - npm install gitbook-cli -g + - npm install honkit - npm install gitbook-plugin-autocover - npm install gitbook-plugin-github - npm install gitbook-plugin-toc - npm install gitbook-plugin-anchors - npm install gitbook-plugin-image-class + - npm install gitbook-plugin-codesnippet script: - - gitbook install - - gitbook build + - npx honkit install + - npx honkit build diff --git a/SUMMARY.md b/SUMMARY.md index 910de76..9e6a9da 100755 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,5 +1,6 @@ # Summary +* [Introduction](README.md) * [Book Convention](book-convention/README.md) * [Quick Start](quick-start/README.md) * [Requirements](requirements/README.md) @@ -9,7 +10,7 @@ * [User Management and Global Actions](user-management/README.md) * [Using the System](using-the-system/README.md) * [Delegation of Event](delegation/README.md) -* [Extending Events](extended-events/README.md) - in progress +* [Extending Events](extended-events/README.md) * [Administration](administration/README.md) * [Managing Feeds](managing-feeds/README.md) * [Updating Python dependencies](updating-python/README.md) @@ -17,16 +18,17 @@ * [PyMISP - Python Library to Access MISP](pymisp/README.md) * [Create an Event Based on a Report](create-event-report/README.md) * [Taxonomies](taxonomy/README.md) -* [Galaxies](galaxy/README.md) - in progress -* [Sightings](sightings/README.md) - in progress -* [Warning lists](warninglists/README.md) - in progress -* [Notice lists](noticelists/README.md) - in progress +* [Galaxies](galaxy/README.md) +* [Sightings](sightings/README.md) +* [Warning lists](warninglists/README.md) +* [Notice lists](noticelists/README.md) * [Categories and Types](categories-and-types/README.md) * [Synchronisation/Sharing](sharing/README.md) * [External Connectors](connectors/README.md) -* [Modules](modules/README.md) - in progress +* [Modules](modules/README.md) * [ZeroMQ - MISP publish-subscribe](misp-zmq/README.md) * [Translations - i18n & l10n](translation/README.md) * [FAQ](faq/README.md) * [Dev FAQ](dev-faq/README.md) * [Appendices](appendices/README.md) + diff --git a/book.json b/book.json index 5bf2259..87b4c13 100644 --- a/book.json +++ b/book.json @@ -3,8 +3,8 @@ "description": "User guide of MISP Malware Information Sharing Platform, a Threat Sharing Platform.", "language": "en", "author": "MISP Contributors", - "plugins": ["autocover", "github", "toc", "anchors", "alerts", "advanced-emoji", "image-class", "last-modified", "search", "sitemap", "codesnippet", "gist", "fontsettings"], - "links": { "sidebar": { "MISP @ GitHub": "https://github.com/MISP/MISP", "PDF Format": "https://www.circl.lu/doc/misp/book.pdf" }}, + "plugins": ["toc", "github", "codesnippet", "last-modified"], + "links": { "sidebar": { "MISP @ GitHub": "https://github.com/MISP/MISP", "PDF Format": "https://www.circl.lu/doc/misp/book.pdf" }}, "pluginsConfig": { "github": { "url": "https://github.com/MISP/" diff --git a/publish.sh b/publish.sh index 56824aa..61a022b 100755 --- a/publish.sh +++ b/publish.sh @@ -1,16 +1,16 @@ #!/bin/bash echo "1/4 html" -gitbook build +npx honkit build echo "2/4 pdf" -gitbook pdf +npx honkit pdf echo "3/4 epub" -gitbook epub +npx honkit epub echo "4/4 mobi" -gitbook mobi +npx honkit mobi echo "Done" mv book.pdf _book mv book.epub _book mv book.mobi _book chmod +r _book/book.pdf _book/book.epub _book/book.mobi cd _book -rsync -azv . circl@cpab.circl.lu:/var/www/nwww.circl.lu/doc/misp/ && rm -rf _book +#rsync -azv . circl@cpab.circl.lu:/var/www/nwww.circl.lu/doc/misp/ && rm -rf _book From 97f98fbc7fb04a7c1b5fee9ba732b31acbaad678 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 10:46:11 +0100 Subject: [PATCH 2/7] chg: [travis] updated to latest Node.js --- .travis.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 950d2b1..831ef63 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ language: node_js node_js: - - "7" + - "14" dist: trusty @@ -12,7 +12,6 @@ install: - sudo npm cache clean -f - sudo npm install -g n - sudo n stable - - sudo ln -sf /usr/local/n/versions/node/8.0.0/bin/node /usr/bin/node - sudo npm update -g - npm install honkit - npm install gitbook-plugin-autocover @@ -23,5 +22,5 @@ install: - npm install gitbook-plugin-codesnippet script: - - npx honkit install + - npm install honkit - npx honkit build From 8428f2d5eaa70a814de90733a51e4c01cb4cd8d1 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 10:49:26 +0100 Subject: [PATCH 3/7] chg: [travis] autocover module (canvas issue with the jpeg lib removed) but is it still required in honkit? --- .travis.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 831ef63..f4ba903 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,7 +14,6 @@ install: - sudo n stable - sudo npm update -g - npm install honkit - - npm install gitbook-plugin-autocover - npm install gitbook-plugin-github - npm install gitbook-plugin-toc - npm install gitbook-plugin-anchors From 03d7efd02e59a64279f42544b301c17cc1a89b0b Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 10:52:55 +0100 Subject: [PATCH 4/7] fix: [travis] missing last-modified GitBook plugin added --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index f4ba903..971f8a7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,6 +19,7 @@ install: - npm install gitbook-plugin-anchors - npm install gitbook-plugin-image-class - npm install gitbook-plugin-codesnippet + - npm install gitbook-plugin-last-modified script: - npm install honkit From f2ee9168b2800c1808f65018cc390faf525a588f Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 11:14:32 +0100 Subject: [PATCH 5/7] chg: [book] anchors plugin tested --- book.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.json b/book.json index 87b4c13..0a9853e 100644 --- a/book.json +++ b/book.json @@ -3,7 +3,7 @@ "description": "User guide of MISP Malware Information Sharing Platform, a Threat Sharing Platform.", "language": "en", "author": "MISP Contributors", - "plugins": ["toc", "github", "codesnippet", "last-modified"], + "plugins": ["toc", "github", "codesnippet", "last-modified", "anchors"], "links": { "sidebar": { "MISP @ GitHub": "https://github.com/MISP/MISP", "PDF Format": "https://www.circl.lu/doc/misp/book.pdf" }}, "pluginsConfig": { "github": { From 70031b1a21e41e0bc2ba84be05782126c44a9918 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 11:20:32 +0100 Subject: [PATCH 6/7] chg: [book] title change - add sitemap --- .travis.yml | 1 + book.json | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 971f8a7..7473d60 100644 --- a/.travis.yml +++ b/.travis.yml @@ -20,6 +20,7 @@ install: - npm install gitbook-plugin-image-class - npm install gitbook-plugin-codesnippet - npm install gitbook-plugin-last-modified + - npm install gitbook-plugin-sitemap script: - npm install honkit diff --git a/book.json b/book.json index 0a9853e..a40efdc 100644 --- a/book.json +++ b/book.json @@ -1,9 +1,9 @@ { - "title": "User guide of MISP Malware Information Sharing Platform, a Threat Sharing Platform.", - "description": "User guide of MISP Malware Information Sharing Platform, a Threat Sharing Platform.", + "title": "User guide of MISP intelligence sharing platform", + "description": "User guide of MISP intelligence sharing platform", "language": "en", "author": "MISP Contributors", - "plugins": ["toc", "github", "codesnippet", "last-modified", "anchors"], + "plugins": ["toc", "github", "codesnippet", "last-modified", "anchors", "sitemap"], "links": { "sidebar": { "MISP @ GitHub": "https://github.com/MISP/MISP", "PDF Format": "https://www.circl.lu/doc/misp/book.pdf" }}, "pluginsConfig": { "github": { From b4eed0c2bd346a5c99a8cd71e45a7586234a9c10 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sun, 28 Feb 2021 11:51:11 +0100 Subject: [PATCH 7/7] chg: [menu] add epub and mobi --- .travis.yml | 2 ++ book.json | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 7473d60..6928f12 100644 --- a/.travis.yml +++ b/.travis.yml @@ -21,6 +21,8 @@ install: - npm install gitbook-plugin-codesnippet - npm install gitbook-plugin-last-modified - npm install gitbook-plugin-sitemap + - npm install gitbook-plugin-advanced-emoji + - npm install gitbook-plugin-image-class script: - npm install honkit diff --git a/book.json b/book.json index a40efdc..4bf93e8 100644 --- a/book.json +++ b/book.json @@ -3,8 +3,8 @@ "description": "User guide of MISP intelligence sharing platform", "language": "en", "author": "MISP Contributors", - "plugins": ["toc", "github", "codesnippet", "last-modified", "anchors", "sitemap"], - "links": { "sidebar": { "MISP @ GitHub": "https://github.com/MISP/MISP", "PDF Format": "https://www.circl.lu/doc/misp/book.pdf" }}, + "plugins": ["toc", "github", "codesnippet", "last-modified", "anchors", "sitemap", "advanced-emoji", "image-class"], + "links": { "sidebar": { "MISP @ GitHub": "https://github.com/MISP", "PDF": "https://www.circl.lu/doc/misp/book.pdf", "EPUB": "https://www.circl.lu/doc/misp/book.epub", "MOBI": "https://www.circl.lu/doc/misp/book.mobi"}}, "pluginsConfig": { "github": { "url": "https://github.com/MISP/"