diff options
| author | Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com> | 2023-01-19 17:43:07 +0200 |
|---|---|---|
| committer | Alyssa Ross <hi@alyssa.is> | 2023-01-20 17:27:44 +0000 |
| commit | 97cceff243d988b91258dbf1b6cf1f0a4bd65f5c (patch) | |
| tree | e54281e85faf5e2aa4874554159e5bf21667b5db /Documentation/contributing/building-documentation.adoc | |
| parent | 8b239acb7f710492b41aaec943262e6aaddb37c0 (diff) | |
| download | spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.tar spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.tar.gz spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.tar.bz2 spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.tar.lz spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.tar.xz spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.tar.zst spectrum-97cceff243d988b91258dbf1b6cf1f0a4bd65f5c.zip | |
Documentation: add contributing information
Hello there! I decided to create a patch from my drafts so this information will not be lost. It still needs some attention. It is a good idea to have the documentation in one place. For us this means that information from these pages https://spectrum-os.org/contributing.html, https://spectrum-os.org/participating.html -- should be moved here https://spectrum-os.org/participating.html. What I did particularly: 1. Added a new chapter "Contributing". Copied here the information from here https://spectrum-os.org/contributing.html, adapting a bit to Spectrum Docs. 2. Moved the "Building Documentation" section from "Development" to "Contributing". 3. In the "Contributing" chapter you can find the following structure: - Communication in Spectrum (copied from https://spectrum-os.org/participating.html) - Documentation Style Guide - Building Documentation I tried to fix all cross-reference links, so this new content can be used right now. Any further updates are very welcome. Signed-off-by: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com> Message-Id: <20230119154307.28303-1-evgeniia.nikolaenko@unikie.com> Reviewed-by: Alyssa Ross <hi@alyssa.is> Signed-off-by: Alyssa Ross <hi@alyssa.is>
Diffstat (limited to 'Documentation/contributing/building-documentation.adoc')
| -rw-r--r-- | Documentation/contributing/building-documentation.adoc | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/Documentation/contributing/building-documentation.adoc b/Documentation/contributing/building-documentation.adoc new file mode 100644 index 0000000..63a3038 --- /dev/null +++ b/Documentation/contributing/building-documentation.adoc @@ -0,0 +1,52 @@ += Building Documentation +:page-parent: Contributing +:page-nav_order: 3 + +// 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:../development/first-patch.adoc[send your patch] and submit the changes for review. |