summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Do not convert -- & --- to en/em-dashTimothée Ravier2021-10-111-0/+4
| | | | | '--' is frequently used for command line options and was thus incorrectly rendered as a special en-dash symbol.
* docs: Copy in API docs and add linkDan Nicholson2021-05-214-1/+36
| | | | | | | | | | | Make a copy of `apidoc/html` to `docs/reference` and then tell Jekyll to include it verbatim. This will include the gtk-doc API docs on the static site. A link is added to the main index. A script is added to do the copy (a symlink won't do) and is setup to run before Jekyll in the GitHub workflow. Ideally this would be a local Jekyll plugin to make the process automatic, but the github-pages gem doesn't allow that.
* docs: Provide bundler setup for building site locallyDan Nicholson2021-05-213-0/+50
| | | | | | | | This mimics the GitHub Pages environment so that you can build and serve the site locally for testing. It's will also be required later for using Jekyll Actions[1] instead of the automated GitHub Pages flow. 1. https://github.com/marketplace/actions/jekyll-actions
* docs: Fix CONTRIBUTING linkDan Nicholson2021-05-201-1/+1
| | | | | | | | | | This returns a 404 since the site is already generated from the docs directory. Furthermore, the `CONTRIBUTING.md` markdown file isn't in the generated site, just the HTML. Instead, use jekyll's `link` tag to create the link. Unfortunately, before jekyll 4.0 (github-pages uses 3.9), you have to prepend the base URL.
* *: rename master to main in tests & examplesTimothée Ravier2021-05-073-13/+13
|
* *: rename master branch to mainTimothée Ravier2021-05-077-24/+24
|
* docs: typo fix for /usr/etcMicah Abbott2021-05-031-1/+1
|
* docs: Add more details about 3-way mergeJonathan Lebon2021-04-301-4/+20
| | | | This came up a few times so let's go into more details in the docs.
* Release 2021.2v2021.2Colin Walters2021-04-151-1/+1
|
* docs: fix "Edit this page on GitHub" linksBenjamin Gilbert2021-04-091-0/+1
|
* docs: Add Torizon to related projects and OSLeonardo Graboski Veiga2021-03-042-0/+31
| | | | | | | | | | | The Torizon platform, includin the TorizonCore OS, the TorizonCore Builder Tool and the Torizon OTA, use OSTree as a base for update the host OS, while the user focus on application development using Docker. Add TorizonCore to the list of Operating systems and distributions using OSTree. Add Torizon and its components to the list of related projects.
* docs: Describe using scratch/empty deltas for initial fetchesColin Walters2021-02-111-0/+21
| | | | Came up with a user hitting ratelimiting from S3.
* templates: add release-checklistLuca BRUNO2020-11-181-0/+6
| | | | This collects all release steps in a release-checklist template.
* docs: Fix various typosKelvin Fan2020-10-196-18/+16
|
* docs: Fix URL in Jekyll _config.ymlTimothée Ravier2020-10-051-1/+1
|
* docs: Move historical README to the docsTimothée Ravier2020-10-021-0/+456
|
* docs: Move and update pages from the manualTimothée Ravier2020-10-029-0/+72
|
* docs: Update Contributing and tutorial pagesTimothée Ravier2020-10-022-24/+22
|
* docs: Update Index pageTimothée Ravier2020-10-011-1/+154
|
* docs: Add Jekyll and theme configTimothée Ravier2020-10-012-0/+41
|
* Fix typoAJ Jordan2020-05-211-1/+1
|
* docs: extend repository typesStefan Agner2020-04-241-7/+8
| | | | | | | | | Clarify where metadata are stored exactly in the `bare-user` case. Make the first sentence of `bare-user` and `bare-user-only` paragraph symetric to make it easier to jump to the right paragraph for readers in a hury. Stree out that `bare-user-only` may loose metadata. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* docs: extend object type documentationStefan Agner2020-04-241-2/+11
| | | | | | | | Extend the object type documentation with file endings used for the individual type. Also clarify in which situation content type objects are used and why they do not match the SHA256 hash today. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* docs: clarify archive repo typeStefan Agner2020-04-241-2/+3
| | | | | | | | | Today `archive-z2` is still used as the default string to indicate a `archive` type repository. Make clear that this is the way it is intended. Otherwise users might think they use an no longer supported OSTree repository since the mode string is still `archive-z2`. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* docs: Fix 'package layering' rpm-ostree linkCole Robinson2020-02-101-1/+1
| | | | Signed-off-by: Cole Robinson <crobinso@redhat.com>
* docs: fix missing as typoTristan Cacqueray2019-05-061-1/+1
| | | | | | | This change fixes a typo in the adapting-existing doc. Closes: #1850 Approved by: cgwalters
* docs: fix switchroot source linkTristan Cacqueray2019-05-051-2/+3
| | | | | | | | | This change updates the switchroot source relative url to an absolute url so that it works from the readthedocs service. This change also removes redundant switchroot.sh reference. Closes: #1849 Approved by: cgwalters
* atomic-upgrades doc: fix example url to fetch a ref checksumSinny Kumari2019-01-021-1/+1
| | | | | | | Signed-off-by: Sinny Kumari <sinny@redhat.com> Closes: #1795 Approved by: cgwalters
* docs: Add Contributing Tutorial to Mkdocs pagesRobert Fairley2018-08-212-13/+11
| | | | | | | | | This adds the Contributing Tutorial (contributing-tutorial.md) to the pages setting of Mkdocs, so that the tutorial will render in the readthedocs.io documentation. Closes: #1711 Approved by: jlebon
* docs: Add detail to CONTRIBUTING.md and link to tutorialbubblemelon2018-08-201-6/+42
| | | | | | | This adds detailed information on commit message guidelines, a link to the contributing tutorial, and minor typo fixes. Closes: #1694 Approved by: cgwalters
* docs: Add contributing tutorialRobert Fairley2018-08-201-0/+450
| | | | | | | | | | | | | This adds a tutorial for developing/contributing to OSTree. The following information is included: - Installing build dependencies for OSTree - Building OSTree, and running in a container and VM - Adding a basic command to OSTree, and testing the command - Suggested git workflows for working with the upstream repo This is helpful to give new contributors a more detailed introduction to developing OSTree, and an idea of what the workflow looks like. Closes: #1694 Approved by: cgwalters
* docs: var/local -> var/usrlocalArnaud Rebillout2018-05-151-1/+1
| | | | | | | Signed-off-by: Arnaud Rebillout <arnaud.rebillout@collabora.com> Closes: #1588 Approved by: jlebon
* docs: Add "Hello World" exampleJonathan Lebon2018-05-081-4/+67
| | | | | | | | | | | Let's get practical faster in the manual and have a simple "Hello World" example right off the bat to hopefully make it easier to grok how OSTree works. Also some minor tweaks on wording around comparisons to git. Closes: #1581 Approved by: cgwalters
* docs: Dual license under CC BY-SA and the GFDLColin Walters2018-02-059-0/+27
| | | | | | | | | | This will allow the text to be used in Wikipedia for example; it also just makes more sense for documentation than the LGPLv2+. Closes: #1431 Closes: #1432 Approved by: jlebon
* Add support for devicetree files alongside the kernel and initramfsWilliam Manley2018-01-162-5/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Much like the (optional) initramfs at `/usr/lib/ostree-boot/initramfs-<SHA256>` or `/usr/lib/modules/$kver/initramfs` you can now optionally include a flattened devicetree (.dtb) file alongside the kernel at `/usr/lib/ostree-boot/devicetree-<SHA256>` or `/usr/lib/modules/$kver/devicetree`. This is useful for embedded ARM systems which need the devicetree file loaded by the bootloader for the kernel to discover and initialise hardware. See https://en.wikipedia.org/wiki/Device_tree for more information. This patch was mostly produced by copy-pasting code for initramfs handling and renaming `s/initramfs/devicetree/g`. It's not beautiful, but it is fairly straightforward. It may be useful to extend device-tree support in a number ways in the future. Device trees dependant on many details of the hardware they support. This makes them unlike kernels, which may support many different hardware variants as long as the instruction-set matches. This means that a ostree tree created with a device-tree in this manner will only boot on a single model of hardware. This is sufficient for my purposes, but may not be for others'. I've tested this on my NVidia Tegra TK1 device which has u-boot running in syslinux-compatible mode. Closes: #1411 Approved by: cgwalters
* docs/related: Add BalenaColin Walters2017-12-071-0/+6
| | | | | | | It's quite related. Closes: #1369 Approved by: jlebon
* docs/related-projects: Add Google Usenix linkColin Walters2017-10-211-0/+5
| | | | | | | Closes: https://github.com/ostreedev/ostree/issues/1284 Closes: #1299 Approved by: cgwalters
* docs: mention the $OSTREE_REPO environment variableMarcus Folkesson2017-10-181-4/+4
| | | | | | | | | | | | $OSTREE_REPO may be set to override the default location of the repository. Link: https://mail.gnome.org/archives/ostree-list/2017-October/msg00003.html Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com> Closes: #1282 Approved by: cgwalters
* lib/deploy: Add .img to end of initramfs in /usr/lib/modulesColin Walters2017-08-211-1/+1
| | | | | | | | | | | | | | | Follow up to <https://github.com/ostreedev/ostree/pull/1079>; I was working on the rpm-ostree updates for this, and I think it's more consistent if we have `.img` here, since that's a closer match to the "remove $kver" that results in `vmlinuz`. Also just best practice to have file suffix types where they make sense. The astute reader might notice this sneaks in a change where we'd crash if the legacy bootdir didn't have an initramfs...yeah, should probably have test coverage of that. Closes: #1095 Approved by: jlebon
* lib/sysroot: Support /usr/lib/modules/$kver for kernel/initramfsColin Walters2017-08-181-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is the new Fedora kernel standard layout; it has the advantage of being in `/usr` like `/usr/lib/ostree-boot`, but it's not OSTree specific. Further, I think in practice forcing tree builders to compute the checksum is an annoying stumbling block; since we already switched to e.g. computing checksums always when doing pulls, the cost of doing another checksum for the kernel/initramfs is tiny. The "bootcsum" becomes more of an internal implementation detail. Now, there is a transition; my current thought for this is that rpm-ostree will change to default to injecting into both `/usr/lib/ostree-boot` and `/usr/lib/modules`, and stop doing `/boot`, then maybe next year say we drop the `/usr/lib/ostree-boot` by default. A twist here is that the default Fedora kernel RPM layout (and what's in rpm-ostree today) includes a kernel but *not* an initramfs in `/usr/lib/modules`. If we looked only there, we'd just find the kernel. So we need to look in both, and then special case this - pick the legacy layout if we have `/usr/lib/modules` but not an initramfs. While here, rework the code to have an `OstreeKernelLayout` struct which makes dealing with all of the variables nicer. Closes: #1079 Approved by: jlebon
* docs/related-projects: Tweak client side snapshot text, add casyncColin Walters2017-08-171-17/+46
| | | | | | | The latter came up on the list. Closes: #1086 Approved by: jlebon
* Update introduction.mdLisa St. John2017-08-091-1/+1
| | | | | | Added missing "is" in the first sentence. Closes: #1067 Approved by: cgwalters
* tree-wide: Replace various uses of `archive-z2` → `archive`Colin Walters2017-06-295-23/+24
| | | | | | | | | | | | The `-z2` is annoying now since it's really a legacy; we've long since supported typing `archive`. Convert the docs fully and explain that. Also do some (but not all) of the tests just to encourage newer tests to use `archive` too. Closes: #980 Approved by: jlebon
* manual: document bare-user-only repo modeJonathan Lebon2017-06-021-0/+7
| | | | | Closes: #903 Approved by: cgwalters
* Rename "osname" → "stateroot"Colin Walters2017-04-243-14/+15
| | | | | | | | | | | | | | | | I never really liked the term "osname". I feel "stateroot" is a *lot* clearer, since the osname/stateroot mostly just holds `/var`. Further it avoids the `os` prefix which is already overloaded. Some of the existing docs already talked about "operating system state", which further reinforces this. There's *lot* more things than this which reference the term "osname", but I don't want to change *everything* yet in this patch in case we decide to do something different - this just gets the highlights. Closes: #794 Approved by: jlebon
* switchroot: Document a bit more, add demo shell implementationFrancesco Giannelli2017-04-191-9/+15
| | | | | | | | | | This could help others who want to integrate with other init systems/initramfs. Commit-message-by: Colin Walters <walters@verbum.org> Closes: #784 Approved by: cgwalters
* doc: fix typo in CONTRIBUTINGChen Fan2017-02-031-1/+1
| | | | | | | Signed-off-by: Chen Fan <fan.chen@easystack.cn> Closes: #667 Approved by: cgwalters
* docs: update pulp_ostree linkJonathan Lebon2017-01-261-1/+1
| | | | | Closes: #657 Approved by: cgwalters
* docs: Fix ostree.version -> versionColin Walters2016-12-231-2/+2
| | | | | | | | | I think originally I had envisioned this as `ostree.version`, but at the last minute we changed it to just `version`. That's what all of the code uses, so let's fix the docs. Closes: #638 Approved by: paulvt
* Fix broken link in docs/CONTRIBUTING.mdAbhay Kadam2016-11-221-1/+1
| | | | | | | | The link for git-rebase manual contains stray character (]) at the end. Closes: #592 Approved by: jlebon
View Lorry Controller Status