Jump to: navigation, search

Help:Contents

Contents

Communicating in the project

There are a number of ways to communicate with the oVirt Community. Mailing lists, IRC, our bug tracker and our patch review system.


Mailing lists

There are many mailing lists in the oVirt project - mostly referenced on the oVirt mailman page. This page describes the main lists and their scope.

User-oriented lists

  • Announce: Announcements about the oVirt project
  • Users: The best place for oVirt user issues - installation, configuration, storage integration, use-cases

Developer-oriented lists

  • Arch: Project-wide developer related issues. Anything which requires the feedback or awareness of developers on two or more of the Engine, Node and VDSM should go here.
  • Engine-devel: Development list for oVirt Engine
  • node-devel: Development list for oVirt Node
  • Vdsm-devel: Development list for VDSM

Project governance and management

  • Board: Discussions amongst the Board for all business
  • Infra: List for oVirt.org Infrastructure team
  • Marketing: List for the oVirt marketing working group
  • Wiki: help for writers and editors of the oVirt wiki

IRC

Primary channel: #ovirt on irc.oftc.net

  • Meetings are held here.
  • This has been the main channel since moving from Freenode.

Secondary channel: #ovirt on irc.freenode.net

  • Some community members are in this channel to start and grow conversations with the Freenode community.
  • Conversations are encouraged to move to the primary IRC channel, but not required.

Weekly Meetings

oVirt has a weekly synchronization meeting which is held on IRC. Information can be seen on the Meetings page.

Bug tracker and code review

You can report bugs, or discuss possible solutions to issues, on the project bug tracker (ovirt project).

We use Gerrit to review patches. To comment on a patch, or submit a patch for review, please read working with oVirt Gerrit.

Community guidelines

We want to keep the oVirt Community a great place to participate, but we need your help to keep it that way. While we have specific guidelines for various tools, in general, you should:

  • Be nice
  • Keep it clean
  • Keep it legal
  • Stay on topic

General guidelines

Search before you ask

A few seconds on Google can help you find an answer to a question, or a past discussion on a subject, which can help us reduce duplication of effort and any associated frustration. Your effort will be appreciated.

  • To search mailing lists: Google "site:lists.ovirt.org <search terms>" - example
  • To search our bugtracker: Google "site:bugzilla.redhat.com ovirt <search terms>" - example
  • To search the wiki: Google "site:wiki.ovirt.org <search terms>" - example

Be pleasant

Our community is defined by the interactions of its members. When people are nice to each other, our community is nice. It can be easy to forget, in a disconnected world, that the person behind the IRC nick is a person. Please remember that.

For each of the communication channels the community uses, there are some channel-specific guidelines.

Mailing list guidelines

  • Keep it short - an email to a mailing list is asking a lot of people for their time to read it. Please be concise.
  • Send email to the right place - please only send email which is on-topic for the list(s) receiving it. You can find a description of the most important community mailing lists on the mailing lists page.
  • Cross-posting is accepted in the oVirt project when appropriate - if you want to ask a question which is relevant to project developers, which will need support of the infrastructure team, then cross-posting to arch@ovirt.org and infra@ovirt.org is fine.

IRC guidelines

  • We hold IRC meetings in the oVirt project - please see meetings for the agenda for team meetings. During meetings, please respect meeting participants and stay on-topic. We use MeetBot to generate meeting minutes - if you would like to assist with minute taking, you can request "chair" status from the meeting leader.
  • Please use fpaste or pastebin if you would like to share long texts (longer than ~3-4 lines)
  • Answer questions if you can - don't be shy about answering questions, even if the answer is "I don't know". It is always helpful, and like many IRC channels, there can be long periods when not many people are around. So you might be the only person to see the question in real time.
  • Use someone's IRC nick when talking to them. Many IRC clients highlight messages which include their IRC nick, making it easier for them to see when someone has something specific to ask them.
  • Be patient - when asking questions, be aware that perhaps no-one is around. Sometimes answers will arrive only after a few minutes.

Wiki contribution guidelines

  • Wiki page naming - Please use descriptive, complete titles for page names. Please do not use CamelCase, All Capital Initials or sentences. Proper nouns or acronyms should be capitalised correctly.
    • Example: "Compiling VDSM" is good, "Feature/DetailedNetworkWiring" could be "Feature/Detailed network wiring", "Engine Adding Messages" could be "Adding messages to Engine"
    • For more details on page naming, refer to Help:Wiki_structure.
  • Writing style - please explain acronyms, keep your writing style correct but informal, and try to avoid jargon where possible.
  • Sub-pages: We discourage the use of sub-pages, with very few exceptions ("Features" is one).

In general, we try to follow the Wikipedia Style Guide, where appropriate.

Bug reporting guidelines

  • Before reporting your bug, please search the bug tracker to see if it has been reported already. A comment added to an existing bug report is also very useful.
  • To report an issue with oVirt, you first need an account on our bug tracker.
  • Once you have confirmed your email address and are logged in, you can create a bug against the oVirt product.
  • If you know which component is causing your problem, then choose that component. Otherwise, if your problem is related to a hypervisor node, choose the "ovirt-node" component. If it is related to the engine, choose "ovirt-engine-core". If you are unsure, choose "ovirt-engine-core", and one of the oVirt developers will reassign the bug for you.
  • When commenting on bugs, please bear in mind that the bug reporter may not know the project as well as possible. If a bug has been reported against the wrong component or product, or if the behaviour observed is expected, please be kind in your comments and explain any changes you make. If you feel the report is not a bug, try to figure out why the expected behaviour is causing problems for the reporter, and suggest a work-around.
  • Above all, be nice. Bug trackers can be emotional places. Separate the person from the problem.

Code submission guidelines

oVirt uses Gerrit to manage code submissions.

  • To get started, follow the instructions for working with oVirt Gerrit
  • When reviewing a patch, if you are unsure whether the code meets project standards, do not score the patch "-1" or "+1".
  • In comments please be considerate toward the work which the patch submitter has done to submit the patch.
  • For patch submitters: Please familiarise yourself with project coding conventions before submitting a patch. Coding conventions for VDSM are in the wiki, and are included in the Maven build process for oVirt Engine.


These guidelines have been adapted from the MeeGo Community

Working on this wiki

The oVirt project wiki has a very low barrier to entry for editors. However, there can be a small learning curve when beginning to use wiki, and we have a number of guidelines that all editors should follow. This page provides those guidelines and a few tips to help you get going.

This document is divided in three parts: gaining edit access, basic wiki editing, and more advanced editing.

Gaining Edit Access

Account creation is moderated by the wiki administrators - once you request an account, and confirm your email address, it will be created for you as quickly as possible. We are protecting this wiki from spambots and bad actors.

If you would like to make changes to wiki pages, do this:

  1. Follow the Log in link at the top of any page;
  2. Click on request a new account.
    • (You may also click on the above link to go directly there.)

There may be some delay in creating your account - if you would like to hurry us up a little, ask for help on the oVirt IRC channel or on the Users mailing list

Once you have your user account, read Help:Editing and the related content in the Category:Documentation for writing on the wiki.

Deprecated method

If you are a wiki contributor already and want to add a new contributor directly, you can follow these directions.

Etiquette guidelines

Refer to Help:Wiki rules and etiquette for some general etiquette guidelines on editing the oVirt wiki.

Creating pages

To have a wiki that is scalable, there is a need to maintain a proper hierarchy and organization. The best way to learn about these is to review Help:Wiki structure and Help:Categories, and then to review the existing layout of the wiki. Our guidelines will help you name your pages in a way that help them be more readable, translatable, and easier for search engines to find and promote.

Editing with Mediawiki

Refer to Help:Wiki syntax and markup for basic information on how to write in MediaWiki syntax. It's really easy, and the wiki makes it easy for you to create a beautiful page with almost no markup at all.

Getting Help

If ever you have questions about editing the oVirt project wiki, or if you need help, please feel free to contact wiki team: via IRC channel (#ovirt on OFTC) or mailing list (arch@ovirt.org).

(Content from https://fedoraproject.org/wiki/Help:Editing under CC BY SA 3.0)

Retrieved from "http://www.ovirt.org/index.php?title=Help:Contents&oldid=6041"