Skip to content

Commit

Permalink
docs(registry-operator): selected static site generator for documenta…
Browse files Browse the repository at this point in the history
…tion (#17)

# Proposed Architectural Decision Record (mADR)

## Checklist

- [x] The context and problem statement are clearly articulated.
- [x] The considered options are listed with relevant links or
references.
- [x] The chosen option is clearly stated along with the rationale.
- [x] The mADR template is filled out accurately.
- [x] Any additional information or references are included.

<!-- Link to the discussion -->
Closes #5

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>
  • Loading branch information
shanduur committed Apr 14, 2024
1 parent 970da7f commit 23342bd
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/5-docs-static-site-generator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Static Site Generator for Documentation

[![](https://img.shields.io/badge/Discussion-5-green)](https://github.com/registry-operator/adr/issues/5)

## Context and Problem Statement

[Describe the context and problem statement prompting the need for this mADR.]

## Considered Options

* [MKDocs](https://www.mkdocs.org) + [Material Theme for MKDocs](https://squidfunk.github.io/mkdocs-material/);
* [Hugo](http://gohugo.io) + [Docsy Theme](https://www.docsy.dev);
* [Hugo](http://gohugo.io) + [Doks Theme](https://github.com/gethyas/doks);
* [Docusaurus](https://docusaurus.io);
* [Cobalt](http://cobalt-org.github.io);
* [Zola](https://www.getzola.org).

## Decision Outcome

Selected option: _MKDocs + Material Theme for MKDocs, because:
- Great documentation of the tool;
- Versioning support out-of-the-box with static versioning via Mike;
- Lots of customization options;
- Sane defaults;

0 comments on commit 23342bd

Please sign in to comment.