Documentation: add "Building the Documentation"

Signed-off-by: Alyssa Ross <hi@alyssa.is>

1 files changed, 44 insertions, 0 deletions

diff --git a/Documentation/building-documentation.adoc b/Documentation/building-documentation.adoc
new file mode 100644
index 0000000..3561c85
--- /dev/null
+++ b/Documentation/building-documentation.adoc
@@ -0,0 +1,44 @@
+= Building the Documentation
+:page-parent: Tutorials
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+This tutorial assumes that you have https://nixos.org/[Nix] installed.
+
+1. Get a copy of the Spectrum source code:
++
+----
+git clone https://spectrum-os.org/git/spectrum
+----
+2. Enter the documentation directory:
++
+----
+cd spectrum/Documentation
+----
+3. Enter the development environment:
++
+----
+nix-shell -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz
+----
+4. In the development shell, do an initial build of the documentation
+site:
++
+----
+scripts/build.sh
+----
+5. Run a development server for previewing changes locally:
++
+----
+jekyll serve
+----
++
+This will serve a local copy of the documentation at http://localhost:4000/.
++
+IMPORTANT: Jekyll doesn't handle rendering of the draw.io diagrams, so
+if you modify any of those, or add new ones, you'll have to run
+`scripts/build.sh` again to do a full rebuild of the site.
+
+Once you've made your changes to the documentation, see
+xref:first-patch.adoc[Sending Your First Patch] for information
+about how to submit them for review.