From aecbc169162cc4d1e8ac6d8e35d5da820e317b45 Mon Sep 17 00:00:00 2001 From: Ramkumar Chinchani Date: Fri, 16 Dec 2022 19:05:40 +0000 Subject: [PATCH] docs: some minor cleanup Signed-off-by: Ramkumar Chinchani --- docs/features.md | 30 ++++++++++++++++++++++++++++++ material/overrides/home.html | 19 +++++++++++++++++++ material/overrides/main.html | 14 -------------- mkdocs.yml | 4 +++- 4 files changed, 52 insertions(+), 15 deletions(-) create mode 100644 docs/features.md diff --git a/docs/features.md b/docs/features.md new file mode 100644 index 0000000..3e91b70 --- /dev/null +++ b/docs/features.md @@ -0,0 +1,30 @@ +# Features + +The key features of `stacker` are: + +## Single Binary + +One statically built binary for simplified download and install with no +additional dependencies or services. + +## Unprivileged + +Build using user namespaces and avoid privileges on host. + +## Repeatable + +Hermetically sealed environment for image builds using LXC containers so that +builds are repeatable without side-effects. + +## Incremental + +Build only the images necessary and rebuild only if any input changed. + +## Open source + +Released as an open source project under Apache2 License. + +## GitHub Action + +Integrated with GitHub as a build-and-push +[action](https://github.com/marketplace/actions/stacker-build-and-push-action). diff --git a/material/overrides/home.html b/material/overrides/home.html index d8274c1..1db1175 100644 --- a/material/overrides/home.html +++ b/material/overrides/home.html @@ -11,6 +11,25 @@

Stacker Build

OCI-native container image builds, simplified

+ + + @stackerbuild + + + + #stacker + + + + Community + +

Get Started diff --git a/material/overrides/main.html b/material/overrides/main.html index df25182..d0a11eb 100644 --- a/material/overrides/main.html +++ b/material/overrides/main.html @@ -27,20 +27,6 @@ {% endblock %} {% block announce %} - - - Twitter - @stackerbuild - - - - Slack - #stacker - {% endblock %} {% block content %} {{ super() }} diff --git a/mkdocs.yml b/mkdocs.yml index 54fee08..0713511 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,7 @@ theme: - search.highlight - search.share - toc.follow + - announce.dismiss icon: repo: fontawesome/brands/github font: @@ -97,10 +98,11 @@ markdown_extensions: nav: - Home: index.md - - What's New: whats-new.md - Get Started: - Get Stacker: get_started/get_stacker.md - Hello Stacker Image: get_started/hello_stacker_image.md + - Features: features.md + - What's New: whats-new.md - Concepts: - OCI Image Layout: concepts/oci_image_layout.md - Stacker Architecture: concepts/stacker_architecture.md