Skip to content

kubev2v/forklift-documentation

Folders and files

NameName
Last commit message
Last commit date
Mar 31, 2022
Feb 2, 2021
Apr 11, 2021
Apr 12, 2021
Feb 1, 2021
Apr 12, 2021
Feb 27, 2025
Mar 7, 2024
Jul 12, 2021
Apr 6, 2021
May 2, 2021
Feb 2, 2021
Apr 6, 2021
Dec 15, 2021
Mar 23, 2022
Dec 15, 2021
Feb 2, 2021
Jun 7, 2021

Repository files navigation

Logo

Forklift documentation

Forklift is an upstream project for migrating virtual machines from VMware or oVirt to KubeVirt.

Contributing to Forklift documentation

This project is Apache 2.0 licensed and accepts contributions via GitHub pull requests.

See CONTRIBUTING for details.

Building a document preview

You can build a document preview by running a Jekyll container.

You must have Podman installed.

  1. Clone the repository:
$ git clone -b source https://github.com/konveyor/forklift-documentation.git && cd forklift-documentation
  1. Create .jekyll-cache and _site directories:
$ for i in .jekyll-cache _site; do mkdir ${i} && chmod 777 ${i}; done
  1. Create a Gemfile.lock file:
$ for i in Gemfile.lock; do touch ${i} && chmod 777 ${i}; done
  1. Run a Jekyll container:
  • If your operating system is SELinux-enabled:

    $ podman run -it --rm --name jekyll -p 4000:4000 -v $(pwd):/srv/jekyll:Z jekyll/jekyll jekyll serve --watch --future

    Note: The Z at the end of the volume (-v) relabels the contents so that they can be written from within the container, like running chcon -Rt svirt_sandbox_file_t -l s0:c1,c2 yourself. You must run this command in the cloned directory.

  • If your operating system is not SELinux-enabled:

    $ podman run -it --rm --name jekyll -p 4000:4000 -v $(pwd):/srv/jekyll jekyll/jekyll jekyll serve --watch --future
  1. Navigate to http://<localhost>:4000 in a web browser to view the preview.

Code of conduct

Contributor Covenant

PR preview rendering