summary refs log tree commit diff
path: root/Documentation
Commit message (Collapse)AuthorAge
...
* release: rename from "img"Alyssa Ross2022-11-13
| | | | | | | | I think this is more descriptive, and "img" is a name better used for VM images. Signed-off-by: Alyssa Ross <hi@alyssa.is> Message-Id: <20221009114036.463071-6-hi@alyssa.is>
* host/start-vm: support multiple block devicesAlyssa Ross2022-11-13
| | | | | | | | | | | | | | This is the first step to being able to do things like having a static base image for an application VM, and another image containing the application to run. When we actually use multiple images we'll need to change how we boot so we know the kernel is booting from the right image — probably by PARTUUID or PARTLABEL — because we can't guarantee how the kernel orders disks inside the VM. Signed-off-by: Alyssa Ross <hi@alyssa.is> Message-Id: <20221009114036.463071-2-hi@alyssa.is>
* Remove bashisms from spectrum shell scriptsHenri Rosten2022-11-09
| | | | | | | | | | | | | | | | This commit removes bashisms from spectrum shell scripts. This change is needed to be able to use the scripts from POSIX-compliant shells which are not bash compatible - such as dash. Also updates the path to the UUID reference used in undocumented-uuids.sh. Signed-off-by: Henri Rosten <henri.rosten@unikie.com> Message-Id: <20221109132730.941054-1-henri.rosten@unikie.com> Fixes: 0a2a5c6 ("Docs: new structure") Reviewed-by: Alyssa Ross <alyssa.ross@unikie.com> Tested-by: Alyssa Ross <alyssa.ross@unikie.com> Signed-off-by: Alyssa Ross <alyssa.ross@unikie.com>
* Docs: new structureJenni Nikolaenko2022-11-08
| | | | | | | | Create separate folders for new parent pages, update Introduction page, remove a and the articles from titles, quick check text for simple english Signed-off-by: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com> Message-Id: <20221108145228.21188-1-evgeniia.nikolaenko@unikie.com>
* Documentation: clarify "long time"Alyssa Ross2022-10-30
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: clarify value of spectrum-configAlyssa Ross2022-09-23
| | | | | | | | | | | | | Before, it was not clear that spectrum-config should be set to a file path, rather than a directory — i.e. whether it override the root of the source tree, or the config.nix path within it. This change clarifies that spectrum-config should be set to a full configuration.nix file path, not the directory that contains it. Reported-by: Ville Ilvonen <ville.ilvonen@unikie.com> Signed-off-by: Alyssa Ross <alyssa.ross@unikie.com> Message-Id: <20220921133341.3120867-1-hi@alyssa.is> Reviewed-by: Ville Ilvonen <ville.ilvonen@unikie.com>
* Documentation/b4.adoc: fix copyright noticeAlyssa Ross2022-09-20
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* shell.nix: automatically configure b4Alyssa Ross2022-09-14
| | | | | | | | | | This will allow people who just want to test one patch series to skip an annoying setup process. To be honest, I'm not sure if it's worth keeping the documentation about manually setting it up. I'm worried it'll just confuse people. But I'm keeping it for now. We can remove it later. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: document build configuration fileAlyssa Ross2022-09-13
| | | | | Signed-off-by: Alyssa Ross <hi@alyssa.is> Message-Id: <20220831093727.282797-4-hi@alyssa.is>
* Documentation: update gemsAlyssa Ross2022-09-13
| | | | | | | | just-the-docs 0.4.0.rc2 includes my styling fix for AsciiDoc examples with titles, which will be used in the build configuration documentation. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Introduce a build configuration fileAlyssa Ross2022-09-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | By default, a file called "config.nix" in the root of the Spectrum repository will be read if it exists. That file should contain an attribute set. Currently, only a "pkgs" key is supported, which allows specifying a custom package set that will be used throughout the Spectrum Nix files. This will allow us to provide configuartion options for people who want to build Spectrum in ways that are probably not suitable for upstreaming. For example, using the "pkgs" config option I'm introducing here, it would be possible to use an overlay to patch individual components, like so: { pkgs = import <nixpkgs> { overlays = [ (final: super: { weston = super.weston.overrideAttrs ({ patches ? [], ... }: { patches = patches ++ [ path/to/weston.patch ]; }); }) ]; }; } Signed-off-by: Alyssa Ross <hi@alyssa.is> Message-Id: <20220831093727.282797-1-hi@alyssa.is> Reviewed-by: Ville Ilvonen <ville.ilvonen@unikie.com> Tested-by: José Pekkarinen <jose.pekkarinen@unikie.com>
* Documentation: make Reply All more prominentAlyssa Ross2022-08-31
| | | | | | | | With the previous wording, somebody who _did_ have a copy of a message probably wouldn't have seen the advice to Reply All, because it was buried at the bottom of the advice for finding copies of messages. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: xref binary cache for building docsAlyssa Ross2022-08-12
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: add READMEAlyssa Ross2022-08-12
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: update just-the-docs to 0.4.0.rc1Alyssa Ross2022-08-12
| | | | | | | This allows us to drop all our patches, which have now been applied upstream. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: add script to update gemsAlyssa Ross2022-08-12
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: update gemsAlyssa Ross2022-08-12
| | | | | | Tested with jekyll serve in nix-shell, and with nix-build. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: use [source,shell] when appropriateAlyssa Ross2022-08-11
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: add "Building the Documentation"Alyssa Ross2022-08-11
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: add a build scriptAlyssa Ross2022-08-11
| | | | | | | | | | | | | | | | Having two commands that need to be run to build the documentation isn't very nice, because it means that the only way to confidently perform a full site build is with nix-build. And with nix-build, it's annoying to view the generated site, because there's no analog to jekyll serve. So let's extract the build script from Nix, to a shell script. This way it can be run by nix-build, or in a nix-shell. This way, it's possible to do most work on the site with jekyll serve, and do a full scripts/build.sh when it's necessary to do things outside of jekyll's remit, like regenerating the diagram SVGs. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: fix source filterAlyssa Ross2022-08-11
| | | | | | | | The name passed into cleanSourceWith's predicate is a path, not just the basename, so we need to extract the basename before checking it against our denylist. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: ignore all SVG filesAlyssa Ross2022-08-11
| | | | | | | | The only SVG file currently used in the documentation is the architecture diagram, which is rendered by SVG. We can make this more precise if we end up with any source SVGs in future. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: chmod +x undocumented-uuids.shAlyssa Ross2022-08-11
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: add "Sending your First Patch"Alyssa Ross2022-08-11
| | | | | | | | | | | I think having this written down in tutorial style is important, so people can follow through some step by step instructions. We already have some similar documentation on <https://spectrum-os.org/contributing.html>, but it doesn't really go into any detail, and I think this belongs in the main documentation. Signed-off-by: Alyssa Ross <hi@alyssa.is> Message-Id: <20220810125405.1133177-1-hi@alyssa.is>
* Documentation/decisions/index.adoc: fix URLAlyssa Ross2022-08-09
| | | | | Reported-by: Profpatsch <mail@profpatsch.de> Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation/replying.adoc: fix typoAlyssa Ross2022-08-05
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: copy-edit and integrate ADRsAlyssa Ross2022-07-22
| | | | | | | | This makes the ADRs accessible from the documentation site, and adds an index page for them, into which I moved the explanation of what they are. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: Architecture Decision RecordVille Ilvonen2022-07-22
| | | | | | | | | | | | | * ADRs based on discussions with Alyssa * A note on ADRs to architecture.adoc * Addressed devel review comments: - copyright + reuse lint - drop "optional" on encryption Signed-off-by: Ville Ilvonen <ville.ilvonen@unikie.com> Message-Id: <CAP-nJwHX11dzQ+aoWsbOx4DzVRYE3LOp7eKV1cU9_ykpFssA3g@mail.gmail.com> Reviewed-by: Alyssa Ross <hi@alyssa.is> Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: link to architecture from rootAlyssa Ross2022-06-15
| | | | | | | This is important information that somebody coming to the Spectrum documentation is likely to be looking for. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: copy edit the architecture overviewAlyssa Ross2022-06-15
| | | | | | | This is substantially the same content, but rephrased and moved around a bit for clarity. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* doc: architecture view with drawio to svg generationVille Ilvonen2022-06-14
| | | | | | | | | | | | | | | | * Initial architecture document view a view to high level stack of Spectrum. * Stack view is generated to svg from drawio using Alyssa's drawio-headless in nixpkgs-upstream. Cherry-picked to nixpkgs-spectrum for testing. * An example to analyze the details of Spectrum dependencies interactively is also provided. Signed-off-by: Ville Ilvonen <ville.ilvonen@unikie.com> Message-Id: <20220607064259.588734-1-ville.ilvonen@unikie.com> Reviewed-by: Alyssa Ross <hi@alyssa.is> Tested-by: Alyssa Ross <hi@alyssa.is> Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: clarify patch workflow for NixpkgsAlyssa Ross2022-06-13
| | | | | | | Previously this documentation assumed the reader was testing a Spectrum patch, but they may also be testing a Nixpkgs patch. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: add info about working with patchesAlyssa Ross2022-06-12
| | | | Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Clarify EUPL SPDX expressionAlyssa Ross2022-05-23
| | | | | | | | | | | | | | | | | | This isn't a license change — the code was always available under potential future EUPL versions because of this language in the EUPL: > Copyleft clause: If the Licensee distributes or communicates copies of the > Original Works or Derivative Works, this Distribution or Communication will be > done under the terms of this Licence or of a later version of this Licence > unless the Original Work is expressly distributed only under this version of the > Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee > (becoming Licensor) cannot offer or impose any additional terms or conditions on > the Work or Derivative Work that alter or restrict the terms of the Licence. But now that reuse 1.0.0 is out, and supports SPDX '+' expressions, we can express this more clearly in SPDX. Signed-off-by: Alyssa Ross <hi@alyssa.is>
* Documentation: link to the right Nix log bugAlyssa Ross2022-05-23
| | | | | | My issue turned out to be invalid, and the actual reason for why it wasn't working was that Nix didn't consider empty logs to exist, which meant that nix store copy-log would fail sometimes.
* Documentation: remove redundant headingAlyssa Ross2022-05-22
| | | | | The "Setting up the binary cache" heading now had the same name as the article itself.
* Documentation: add a suggested start to the indexAlyssa Ross2022-05-22
| | | | | | | Now that the documentation is organised into categories, it's less clear from the sidebar where somebody should go to get started. So let's add a note encouraging them to try the "Getting Spectrum" tutorial first.
* Documentation: reorganize for DiátaxisAlyssa Ross2022-05-22
| | | | | | | | | | | The Diátaxis[1] framework promotes separating technical documentation into Tutorials, How-tos, Reference, and Explanation. Not all of our documentation was written to be specifically one of these things, but each documentation page has one it's closest to, so organising everything into the proper category is a good start. It should also encourage the system to be followed for new documentation. [1]: https://diataxis.fr/
* Documentation: fix AsciiDoctor TOC formattingAlyssa Ross2022-05-22
|
* Documentation: add an index pageAlyssa Ross2022-05-19
| | | | | I don't really know what should go here, but we need to have something, so that trying to go to the documentation root isn't a 404.
* Documentation: build for /doc in Nix buildAlyssa Ross2022-05-19
| | | | | This ensures all the links will be correct when it's hosted on <https://spectrum-os.org/doc/>.
* Documentation: don't use domain names in linksAlyssa Ross2022-05-19
|
* Documentation: remove duplicate binary cache keyAlyssa Ross2022-04-26
|
* Documentation: capitalize binary cache doc titleAlyssa Ross2022-04-26
|
* Documentation: add script to find missing UUIDsAlyssa Ross2022-04-26
|
* Documentation: add UUID referenceAlyssa Ross2022-04-26
|
* Documentation: exclude .license files from outputAlyssa Ross2022-04-26
|
* Documentation: clarify the GFDL SPDX expressionAlyssa Ross2022-04-23
|
* Documentation: make the site title title caseAlyssa Ross2022-04-23
|
* Documentation: link to other parts of the websiteAlyssa Ross2022-04-23
|
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-06-10 21:48:03 +0000