Code Monkey home page Code Monkey logo

forklift-documentation's Introduction

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

forklift-documentation's People

Contributors

apinnick avatar jameslabocki avatar fabiendupont avatar iranzo avatar sbeskin-redhat avatar richardhoch avatar stoobie avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.