README.md

The MicroShift documentation

This repository contains the assets required to build the MicroShift website and documentation. We welcome contributions.

Prerequisites

To use this repository, you need the following installed locally:

NOTE: make server command will install hugo-extended binary to the current directory

• npm
• Hugo (Extended version)

Clone the repository and navigate to the directory:

git clone https://github.com/redhat-et/microshift-documentation.git
cd microshift-documentation

Running the website locally using Hugo

npm install
# if you do want to download and use hugo-extended in current directory
make server
# or if you already have hugo-extended installed in $PATH
hugo serve

This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.

Get involved with MicroShift

• Join us on Slack! (Invite to the Slack space)

Code of conduct

Participation in the MicroShift community is governed by the CNCF Code of Conduct.

Thank you

MicroShift welcomes community participation, and we appreciate your contributions to MicroShift and to our documentation!