shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-12-22 17:35:55 +03:00
Code Issues Projects Releases Wiki Activity
038bb57a8d
ostree/docs
History
Timothée Ravier 038bb57a8d docs: Misc whitespace fixes
2024-02-20 17:04:44 +01:00
..
_sass/color_schemes docs: Add Jekyll and theme config 2020-10-01 19:32:12 +02:00
_config.yml docs: Use upstream theme & update to 0.4.1 2023-03-10 12:17:16 +01:00
adapting-existing.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
atomic-rollbacks.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
atomic-upgrades.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
authenticated-repos.md docs: Misc whitespace fixes 2024-02-20 17:04:44 +01:00
bootloaders.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
buildsystem-and-repos.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
composefs.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
contributing-tutorial.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
CONTRIBUTING.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
deployment.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
formats.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
Gemfile docs: Add webrick dependancy for building site locally 2024-02-16 13:00:41 +00:00
ima.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
index.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
introduction.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
prep-docs.sh docs: Publish man pages 2022-04-08 19:25:32 -06:00
README-historical.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
README.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
related-projects.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
repo.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
repository-management.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00
var.md docs: Consistently use SPDX identifiers 2024-02-20 17:04:02 +01:00

README.md

This documentation is written in Jekyll format to be published on GitHub Pages. The rendered HTML will be automatically built and published, but you can also use Jekyll locally to test changes.

First you need to install Ruby and RubyGems to get Jekyll and the other gem dependencies. This is easiest using the distro's packages. On RedHat systems this is rubygems and on Debian systems this is ruby-rubygems.

Next Bundler is needed to install the gems using the provided Gemfile. You can do this by running gem install bundler or using distro packages. On RedHat systems this is rubygem-bundler and on Debian systems this is ruby-bundler.

Now you can prepare the Jekyll environment. Change to this directory and run:

bundle config set --local path vendor/bundle
bundle install

Finally, run the prep-docs.sh script and then render and serve the site locally with Jekyll:

./prep-docs.sh
bundle exec jekyll serve