commit 31a2bf7461b9e0891628d2a624875fa4a1da8086
parent f6f7ee29e47ee15c48cdd1ec04ccf94105e422dc
Author: Vincent Demeester <vincent@sbr.pm>
Date: Sun, 29 Mar 2020 18:33:49 +0200
Refine docs/ organization (with sitemap) 🔍
- Add a crafter `index.org` file
- Generate a sitemap in `sitemap.org`
- Create empty `install/` docs to test the sitemap
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
6 files changed, 47 insertions(+), 3 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,4 @@ result
home.nix
*.retry
assets/machines.nix
-docs/index.org-
\ No newline at end of file
+docs/sitemap.org+
\ No newline at end of file
diff --git a/docs/index.org b/docs/index.org
@@ -0,0 +1,35 @@
+#+TITLE: Configurations
+#+OPTIONS: toc:nil
+#+FILETAGS: @home infra configuration dotfiles
+
+This set of pages and articles are describing and discussion my
+configurations. Configurations means the [[https://dotfiles.github.io/][dotfiles]] for miscellaneous software and operating
+systems (like [[https://nixos.org][=NixOS=]], or [[https://www.gnu.org/software/emacs/][GNU Emacs]]).
+
+This documents comes from my [[https://gitlab.com/vdemeester/home][monorepo]] for my personal tools and infrastructure. I'm trying
+to use [[https://nixos.org/nix/][Nix]] as much as possible for those configuration, using [[https://nixos.org][=NixOS=]] and
+[[https://rycee.gitlab.io/home-manager/][=home-manager=]]. But it is not limited to this. The goal of my [[https://gitlab.com/vdemeester/home][monorepo]] is:
+
+- Centralized literate configuration
+- Shareable nix modules (e.g. =zsh= configuration on =nixos= and using =home-manager=)
+- One repository to rule all my configurations, for all my machines.
+
+The following part of this page tries to present an organization to all my
+configurations ; but there is a [[file:sitemap.org][sitemap]] if you want to see all the content.
+
+* The Setup
+
+My [[https://gitlab.com/vdemeester/home][monorepo]] can be used on multiple system — [[https://nixos.org][=NixOS=]] and [[https://fedoraproject.org/][Fedora]] mainly, but it should work
+on anything that can run [[https://nixos.org/nix][Nix]] is available, and where [[https://rycee.gitlab.io/home-manager/][=home-manager=]] works.
+
+- [[file:install/nixos.org][How to install on NixOS]] explains how to setup and use the monorepo when installing NixOS
+- [[file:install/fedora.org][How to install on Fedora]] explains how to setup and use the monorepo when installing on
+ Fedora (after the installation)
+- [[file:install/bootstrap.org][Bootstrap]] script explained
+
+* Triage
+
+Those are =work-in-progress= document, that needs to be refined, redefined or completed.
+
+- [[file:mails.org][My email setup]]
+- [[file:emacs.old.org][Vincent Demeester's .emacs.d]]
diff --git a/docs/install/bootstrap.org b/docs/install/bootstrap.org
@@ -0,0 +1 @@
+#+TITLE: Bootstrap script
diff --git a/docs/install/fedora.org b/docs/install/fedora.org
@@ -0,0 +1 @@
+#+TITLE: Fedora installation
diff --git a/docs/install/nixos.org b/docs/install/nixos.org
@@ -0,0 +1 @@
+#+TITLE: NixOS installation
diff --git a/publish.el b/publish.el
@@ -18,7 +18,13 @@
:publishing-function org-html-publish-to-html
:publishing-directory "../www/public/configurations"
:exclude ,(regexp-opt '("README.org" "draft"))
- :auto-sitemap nil
+ :auto-sitemap t
+ :sitemap-filename "sitemap.org"
+ :sitemap-title "Configurations"
+ ;;:sitemap-format-entry sbr/org-sitemap-format-entry
+ :sitemap-style tree
+ :sitemap-sort-files anti-chronologically
+ ;;:sitemap-function sbr/org-publish-sitemap
:with-footnotes t
:with-toc t
:with-drawers t
