Skip to content

cloudhippie/website

Repository files navigation

Cloudhippie: Documentation

General Workflow

Website for the Cloudhippie project including some landing page and a documentation around it, you can find this website at cloudhippie.de.

Hosting

The website is hosted on Netlify, the website gets automatically updated on every push to the master branch by our CI system.

Install

This website uses the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine. The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

After the installation of Hugo and NodeJS you can easily generate the website and serve it on localhost:1313, just execute these commands and stop it with Ctrl+C:

npm install
make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Security

If you find a security issue please contact [email protected] first.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

Apache-2.0

Copyright

Copyright (c) 2023 Cloudhippie <[email protected]>