patches and low-level development discussion
 help / color / mirror / code / Atom feed
1beffa8f7d335de8989e367126de59c7854abf7d blob 1391 bytes (raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
= Building Documentation
:page-parent: Contributing
:page-nav_order: 4

// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0

Make sure you have https://nixos.org/download.html[Nix] installed.
You may also want to xref:../installation/binary-cache.adoc[configure the Spectrum
binary cache], to avoid having to wait for dependencies to compile on
your local system.

. Get a copy of the Spectrum source code:
+
[source,shell]
----
git clone https://spectrum-os.org/git/spectrum
----
. Enter the documentation directory:
+
[source,shell]
----
cd spectrum/Documentation
----
. Enter the development environment:
+
[source,shell]
----
nix-shell -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz
----
. In the development shell, do an initial build of the documentation
site:
+
[source,shell]
----
scripts/build.sh
----
. Run a development server for previewing changes locally:
+
[source,shell]
----
jekyll serve
----
+
This will serve a local copy of the documentation at http://localhost:4000/.
+
IMPORTANT: Jekyll does not handle rendering of the draw.io diagrams. If you
modify any of those, or add new ones, run `scripts/build.sh` again to do a full
rebuild of the site.

After making changes to the documentation, see how to
xref:first-patch.adoc[send your patch] and submit the changes for review.
debug log:

solving 1beffa8 ...
found 1beffa8 in https://spectrum-os.org/git/spectrum

Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).