Skip to content

Latest commit

 

History

History
119 lines (85 loc) · 4.15 KB

CONTRIBUTING.md

File metadata and controls

119 lines (85 loc) · 4.15 KB
Raw

How to contribute

Please join us! All content on ovirt.org is community-driven, and we welcome contributions!

General guidelines

Make sure to follow the standard GitHub best practices:

  • If you work offline in a text editor, fork the repository before you clone it and keep your fork synced.
  • Create topic branches and use meaningful titles in the branch names.
  • Submit a pull request for every change, even if you are a site maintainer.

Access the source files

You can access the source content in one of the following ways:

  • Fork and clone this repository to your local machine. You can then use your favorite text editor and standard Git commands to work on the files.
  • From the website, scroll down to the bottom of the topic page that you want to edit and click "Edit this page on GitHub". You can then edit the file directly in the GitHub editor.
  • From this source repository directory, navigate to the file that you want to edit and click the Edit icon (hover text "Edit this file") at the top-right corner of the topic header. You can then edit the file directly in the GitHub editor.

Add new author

Author information is stored in data/authors.yml. If you write some content for the site, please add yourself to the list of authors.

Add new content

All content in the website is written in Markdown. For information on formatting Markdown, see Markdown Basics.

You can create a new topic file in one of the following ways:

  • From your local Git repo folder, navigate to the relevant directory, create a new text file and save it with the following naming convention: <name>.html.md

  • From the GitHub repository, navigate to the relevant directory and click the New File button at the top-right corner of the pane.

If you want to use an existing file as a template, click the Edit icon for this README and review the headings, lists, and inline formatting used in this file.

Page metadata

Additional metadata can be provided to each page by inserting block of following format at the beginning of the document:

---
key: value
---

For example:

---
title: Download
authors: gshereme,sandrobonazzola
---

Test your changes locally

If you edit any file type other than MD, for example HAML, YAML, or CSS, deploy the site locally and test your changes.

For simple changes, you can try the Middleman hot reload server, but note that it doesn't understand .htaccess and mod_redirect rules that we use on the production apache server.

Note: the latest version of Ruby crashes when trying to start the server. Use Ruby 2.1 with the help of rvm.

Run:

rvm use 2.1
./setup.sh && ./run-server.sh

or

sudo ./docker-setup.sh
sudo ./docker-run.sh

If the site builds successfully, you will see this message: The Middleman is standing watch at http://[address]:4567

For complex changes, test with a local apache. Make sure apache is configured to allow .htaccess files by replacing AllowOverride None with AllowOverride None in httpd.conf.

Run:

rvm use 2.1
# clean the build dir if it exists
rm -rf build
bundle exec middleman build --verbose
# copy all built content into the apache root
sudo rsync -av build/ /var/www/html/

Submit your changes

when you finish creating or editing content, commit your changes to the branch and submit a pull request for review. Fill out the commit template. The commit message should include a detailed description of the changes and as much context as possible.

NOTE: Make sure to submit a pull request even if you have commit rights to the repository, to ensure consistent review and collaboration practices.

After your pull request is merged, the website auto-deploys and you can see the published changes within 10-15 minutes.

Report problems or make suggestions

If you find a problem with the content, with the website, or have suggestions for new content but unsure how to proceed, simply submit an issue here.

Still need help?

If you have any other questions, simply submit an issue here and provide as much detail as possible.