shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-10-26 08:55:19 +03:00
Code Issues Projects Releases Wiki Activity
a84e56d603
ostree/docs
History
Eric Curtin 1aec4deb86 docs: Add webrick dependancy for building site locally 
This mimics the GitHub Pages environment so that you can build and serve
the site locally for testing. It requires webrick these days.

Signed-off-by: Eric Curtin <ecurtin@redhat.com>
2024-02-16 13:00:41 +00: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/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
atomic-rollbacks.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
atomic-upgrades.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
authenticated-repos.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
bootloaders.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
buildsystem-and-repos.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
composefs.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
contributing-tutorial.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
CONTRIBUTING.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
deployment.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
formats.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
Gemfile docs: Add webrick dependancy for building site locally 2024-02-16 13:00:41 +00:00
ima.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
index.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
introduction.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
prep-docs.sh docs: Publish man pages 2022-04-08 19:25:32 -06:00
README-historical.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
README.md docs: Copy in API docs and add link 2021-05-21 10:46:49 -06:00
related-projects.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
repo.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
repository-management.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00:00
var.md docs/atomic-rollbacks: Add a section on rollbacks 2024-02-13 17:07:17 +00: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