Skip to content

Latest commit

 

History

History
143 lines (97 loc) · 5.25 KB

CONTRIBUTING.md

File metadata and controls

143 lines (97 loc) · 5.25 KB
Raw

How to contribute

All content on this website 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 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: Virtio RNG Enhancements
feature_name: Virtio RNG
feature_modules: virtio
feature_status: WIP
---

Required metadata

Some pages requires certain metadata to be present

Feature pages

Pages in subtree source/develop/release-management/features.

  • title
  • feature_name
  • feature_modules
  • feature_status

Add a new blog post

If you have an idea for a blog post, we'd love to help you publish it. Follow the steps to access the source files and add new content, and when you submit the pull request the community team will provide editorial review, so don't worry if you are unsure of your writing skills!

NOTE: Blog posts contain additional metadata and naming conventions that Middleman uses to accurately sort and display the content. To ensure consistent formatting, you can use the first blog post source file name and header as a template.

Update existing content

To modify incorrect, obsolete, or outdated information, you can edit the topic yourself and submit a pull request. The pull request will be reviewed by contributors with commit rights, and if it is accepted it will be merged to the website.

To edit content files, follow the steps in [Access the source files](### Access the source files) and edit the file.

IMPORTANT: Some content was converted from legacy MediaWiki and contains a special header used for auto-redirects. If you edit a legacy file, do not modify or remove this header.

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.

We plan to add pre-merge staging accessible from GitHub, but until this happens please follow this step and add a confirmation in the pull request description that the local test ran successfully.

Run:

./setup.sh && ./run-server.sh

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

Submit your changes

when you finish creating or editing content, commit your changes to the branch and submit a pull request for review. 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, you can create a GitHub issue to voice your request or question. All issues are reviewed by the community team and triaged according to severity, priority, and complexity.

To open a GitHub issue, navigate to the GitHub repo website (you are here!) and click the Issues tab in the top navigation bar of the repo. Make sure to search the issues list before you create a new issue, as other contributors might have already reported similar issues.

Still need help?

If you have any questions that this README did not answer, you can send us an email at [email protected] and we will do our best to help you get started.