An open API service indexing awesome lists of open source software.

https://github.com/kubev2v/forklift-documentation

Forklift documentation
https://github.com/kubev2v/forklift-documentation

forklift forklift-documentation upstream

Last synced: 5 months ago
JSON representation

Forklift documentation

Awesome Lists containing this project

README

          

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](LICENSE) and accepts contributions via
GitHub pull requests.

See [CONTRIBUTING](CONTRIBUTING.md) 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:
```console
$ git clone -b source https://github.com/kubev2v/forklift-documentation.git && cd forklift-documentation
```
2. Create `.jekyll-cache` and `_site` directories:
```console
$ for i in .jekyll-cache _site; do mkdir ${i} && chmod 777 ${i}; done
```
3. Create a `Gemfile.lock` file:
```console
$ for i in Gemfile.lock; do touch ${i} && chmod 777 ${i}; done
```
4. Run a Jekyll container:
- If your operating system is SELinux-enabled:

```console
$ 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:

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

5. Navigate to `http://:4000` in a web browser to view the preview.

## Code of conduct

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)

## PR preview rendering

[![](https://www.netlify.com/img/global/badges/netlify-light.svg)](https://www.netlify.com)