Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit d0994d7

Browse files
author
Daniel Patanin
committed
Add adr file about new documentation framework
1 parent 71c5212 commit d0994d7

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

docs/adr/adr_0002.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[ADR-0002]]
2-
= ADR-0000: How can we introduce a more general extension concept for data processing modules?
2+
= ADR-0002: How can we introduce a more general extension concept for data processing modules?
33

44
[cols="h,d",grid=rows,frame=none,stripes=none,caption="Status",%autowidth]
55
|====

docs/adr/adr_0003.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[ADR-0003]]
2-
= ADR-0002: How can we introduce a mechanism to start specialized scans on the results of previous scans?
2+
= ADR-0003: How can we introduce a mechanism to start specialized scans on the results of previous scans?
33

44
[cols="h,d",grid=rows,frame=none,stripes=none,caption="Status",%autowidth]
55
|====

docs/adr/adr_0004.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[[ADR-0004]]
2+
= ADR-0004: Which framework could be more useful for documentation purposes?
3+
4+
[cols="h,d",grid=rows,frame=none,stripes=none,caption="Status",%autowidth]
5+
|====
6+
7+
| Status
8+
| ACCEPTED
9+
10+
| Date
11+
| 2020-09-29
12+
13+
| Author(s)
14+
| Daniel Patanin daniel.patanin@iteratec.com
15+
16+
|====
17+
18+
== Context
19+
20+
Since the last major update of our GatsbyJS based website, the original requirements for our ideal webpage have changed.
21+
Originally we needed a website, which could present our project briefly and hold the documentation, dynamically build from our main repository.
22+
The first aspect has changed quite severe since we aim for an actual marketing oriented homepage now. The second goal stays the same, but changed contextually.
23+
We no longer just want to host the documentation, but furthermore want to stay on modern documentation standards and since our team does not want to invest too
24+
much time into the documentation site's development and maintenance, we are looking for a component library or whole framework specialized on documentation.
25+
26+
== Decision
27+
28+
We did not evaluate many different frameworks. The journey was quite short in fact. The first documentation oriented framework we looked at was Docusaurus.
29+
As I progressed into trying out to build a basic Docusaurus site and copied all documentation files into it, the website actually looked nice and quite finished already,
30+
after only a few hours of tinkering. It is that easy and simple to understand, especially with it's own good documentation. After reviewing this very basic website,
31+
we decided to advance this and already try to retrieve the documentation remotely from our main repository. At this point the decision was pretty clear already: If there
32+
is no major drawback coming up, Docusaurus is our new framework of choice. And there was no drawback major enough to revoke this decision (yet). Everything we programmatically
33+
wanted to achieve, we could do so by basic scripting and we never really have to think about components like the sidebar, navbar etc. since this is all done completely automatically
34+
by Docusaurus itself.
35+
36+
== Consequences
37+
38+
As simple and easy it sounds, so it is, meaning that since the build is automated to a very big degree, we are 'forced' to follow Docusaurus' exact guidelines and mechanics.
39+
For now they are almost identical to what we require. And of course we can build custom components and custom pages, but the documentation and blog part of the site are very strict.
40+
Since we want to use this website mainly (ideally only) for documentation purposes, we need a separate marketing page (more on that in <<ADR-0005>>). As far as maintenance goes,
41+
we mostly need to maintain our custom build scripts. Everything else is very much automated.

0 commit comments

Comments
 (0)