summary refs log tree commit diff
path: root/Documentation
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2022-08-11 15:11:55 +0000
committerAlyssa Ross <hi@alyssa.is>2022-08-11 15:11:55 +0000
commitb3576aeb0bacf879a90c30a611785049382232d9 (patch)
tree4b90c594225e72736bb940079d5dd842a5e03189 /Documentation
parent56fa3e421f5f9621f60f48d6695310ce7b172734 (diff)
downloadspectrum-b3576aeb0bacf879a90c30a611785049382232d9.tar
spectrum-b3576aeb0bacf879a90c30a611785049382232d9.tar.gz
spectrum-b3576aeb0bacf879a90c30a611785049382232d9.tar.bz2
spectrum-b3576aeb0bacf879a90c30a611785049382232d9.tar.lz
spectrum-b3576aeb0bacf879a90c30a611785049382232d9.tar.xz
spectrum-b3576aeb0bacf879a90c30a611785049382232d9.tar.zst
spectrum-b3576aeb0bacf879a90c30a611785049382232d9.zip
Documentation: use [source,shell] when appropriate
Signed-off-by: Alyssa Ross <hi@alyssa.is>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/building-documentation.adoc5
-rw-r--r--Documentation/first-patch.adoc4
2 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/building-documentation.adoc b/Documentation/building-documentation.adoc
index 3561c85..4e7b622 100644
--- a/Documentation/building-documentation.adoc
+++ b/Documentation/building-documentation.adoc
@@ -8,27 +8,32 @@ This tutorial assumes that you have https://nixos.org/[Nix] installed.
 
 1. Get a copy of the Spectrum source code:
 +
+[source,shell]
 ----
 git clone https://spectrum-os.org/git/spectrum
 ----
 2. Enter the documentation directory:
 +
+[source,shell]
 ----
 cd spectrum/Documentation
 ----
 3. Enter the development environment:
 +
+[source,shell]
 ----
 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:
 +
+[source,shell]
 ----
 scripts/build.sh
 ----
 5. Run a development server for previewing changes locally:
 +
+[source,shell]
 ----
 jekyll serve
 ----
diff --git a/Documentation/first-patch.adoc b/Documentation/first-patch.adoc
index 22140e4..30672b9 100644
--- a/Documentation/first-patch.adoc
+++ b/Documentation/first-patch.adoc
@@ -21,12 +21,14 @@ your changes will probably be very familiar.
 
 1. Create a branch for your changes:
 +
+[source,shell]
 ----
 git checkout -b fix-docs # for example
 ----
 2. Make changes in your editor.
 3. Stage and commit your changes:
 +
+[source,shell]
 ----
 git add Documentation/first-patch.adoc # for example
 git commit -s
@@ -41,6 +43,7 @@ Certificate of Origin], which is mandatory for Spectrum patches.
 
 Once you're happy with how the commits on your branch look, run:
 
+[source,shell]
 ----
 git send-email --to devel@spectrum-os.org --confirm=always origin/main
 ----
@@ -69,6 +72,7 @@ If you need to make changes to your patch, and submit a new version,
 use https://git-rebase.io/[`git rebase`] to create a new version of
 your patch(es), and submit it like this:
 
+[source,shell]
 ----
 git send-email -v2 --to devel@spectrum-os.org --confirm=always origin/main
 ----