From nobody Mon Feb 9 16:02:44 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1646668840; cv=none; d=zohomail.com; s=zohoarc; b=KbxyVp4jXYcL1ehsawH6tjY2CGzI7m1q+vh8A6Pn/aqKJjdidLAzB5BSHA1ZeVlAOtES5/cSJd7fZ/HCQy669l5fbI+DNv/LRHQD84d37RRb19hcoUz3Pi1QmqsjHyb+SHK5G4Xf3hpc0CP3V3WDqyDw9oYgmztW/RdyCbUAnVg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1646668840; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=0454eLxP36jpoFqLsLZjNrekov7B+/Cg1KSOmYg4+Kc=; b=JhcBWhAwLfXFJ6Zxn1iRqbpO+sVy8Satv9otVZeIxisfmSF4lldBrWUOJTTEJpv1s54P0CqgTRAtmCsxDN7kcs01u+CiuCkhFmGe8IGieyh3depIORlf1QN/oO9BqNO68+iyL0gq4L2PcaGPc5j4X/O4IARLDFVlz88LYpwPxJo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1646668840889408.73785041766746; Mon, 7 Mar 2022 08:00:40 -0800 (PST) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-486-XM6WyXubNuqVHE8l7-k_CQ-1; Mon, 07 Mar 2022 11:00:25 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B23678FA3C7; Mon, 7 Mar 2022 16:00:05 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9AE671457F16; Mon, 7 Mar 2022 16:00:05 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 6C07319305AE; Mon, 7 Mar 2022 16:00:05 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 1387C196BB82 for ; Mon, 7 Mar 2022 16:00:04 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id CA0657DE5E; Mon, 7 Mar 2022 16:00:03 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.30]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3066E7D3CE for ; Mon, 7 Mar 2022 16:00:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1646668840; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=0454eLxP36jpoFqLsLZjNrekov7B+/Cg1KSOmYg4+Kc=; b=E7syTLA6Abx4POgcEhz+YXWEQ6UZd8PtenrEXqDGMl07EaAdlOrqSFLMAUFiufnRIMTvI2 3X/zWm/z82zgrW9WTiljenf7B1aRd28y+JBj1NNKcjjYX7E8IMiiswXfMjRBS01/fcZjV4 G+4IQfKm1mGAopx6tj1rSKlYcMBhQRc= X-MC-Unique: XM6WyXubNuqVHE8l7-k_CQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 06/17] docs: Convert 'contribute' page to rST Date: Mon, 7 Mar 2022 16:59:26 +0100 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1646668842418100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: Peter Krempa --- docs/contribute.html.in | 143 ---------------------------------------- docs/contribute.rst | 105 +++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 106 insertions(+), 144 deletions(-) delete mode 100644 docs/contribute.html.in create mode 100644 docs/contribute.rst diff --git a/docs/contribute.html.in b/docs/contribute.html.in deleted file mode 100644 index 790114a56d..0000000000 --- a/docs/contribute.html.in +++ /dev/null @@ -1,143 +0,0 @@ - - - - -

Contributing to libvirt

- -

- This page provides guidance on how to contribute to the - libvirt project. -

- -
    - -

    Contributions required

    - -

    - The libvirt project is always looking for new contributors to - participate in ongoing activities. While code development is a - major part of the project, assistance is needed in many other - areas including documentation writing, bug triage, testing, - application integration, website / wiki content management, - translation, branding, social media and more. The only - requirement is an interest in virtualization and desire to - help. -

    - -

    - The following is a non-exhaustive list of areas in which - people can contribute to libvirt. If you have ideas for - other contributions feel free to follow them. -

    - -
      -
    • Software development. The official upstream cod= e are - kept in various Git reposi= tories. - The core library / daemon (and thus the bulk of coding) is written= in C, - but there are language bindings written in Python, Perl, Java, Rub= y, - Php, OCaml and Go. There are also higher level wrappers - mapping libvirt into other object frameworks, such GLib, - CIM and SNMP. For those interested in working on the core parts of - libvirt, the contributor guidelines a= re - mandatory reading
      • -
    • Translation. All the libvirt modules aim to sup= port - translations where appropriate. All translation is - handling outside of the normal libvirt review process, - using the Fedora - instance of the Weblate tool. Thus people wishing - to contribute to translation should join the Fedora - translation team
      • -
    • Documentation. There are docbook guides on vari= ous - aspects of libvirt, particularly application development - guides for the C library and Python, and a virsh command - reference. There is thus scope for work by people who are - familiar with using or developing against libvirt, to - write further content for these guides. There is also a - need for people to review existing content for copy editing - and identifying gaps in the docs
      • -
    • Website / wiki curation. The bulk of the websit= e is - maintained in the primary GIT repository, while the wiki - site uses mediawiki. In both cases there is a need for - people to both write new content and curate existing - content to identify outdated information, improve its - organization and target gaps.
      • -
    • Testing. There are a number of tests suites tha= t can run - automated tests against libvirt. The coverage of the tests - is never complete, so there is a need for people to create - new test suites and / or provide environments to actually - run the tests in a variety of deployment scenarios.
      • -
    • Code analysis. The libvirt project has access t= o the coverity - tool to run static analysis against the codebase, however, - there are other types of code analysis that can be useful. - In particular fuzzing of the inputs can be very effective - at identifying problematic edge cases.
      • -
    • Security handling. Downstream (operating system= ) vendors - who distribute libvirt may wish to propose a person to - be part of the security handling team, to get early access - to information about forthcoming vulnerability fixes.
      • -
    • Evangelism. Work done by the project is of no b= enefit - unless the (potential) user community knows that it - exists. Thus it is critically important to the health - and future growth of the project, that there are a people - who evangelize the work created by the project. This can - take many forms, writing blog posts (about usage of features, - personal user experiences, areas for future work, and more), - syndicating docs and blogs via social media, giving user - group and/or conference talks about libvirt.
      • -
    • User assistance. Since documentation - is never perfect, there are inevitably cases where users - will struggle to attain a deployment goal they have, or - run into trouble with managing an existing deployment. - While some users may be able to contact a software vendor - to obtain support, it is common to rely on community help - forums such as libvirt users - mailing list, or sites such as - sta= ckoverflow. - People who are familiar with libvirt and have ability & - desire to help other users are encouraged to participate in - these help forums.
      • -
    - -

    Communication

    - -

    - For full details on contacting other project contributors - read the contact page. There - are two main channels that libvirt uses for communication - between contributors: -

    - -

    Mailing lists

    - -

    - The project has a number of - mailing lists for - general communication between contributors. - In general any design discussions and review - of contributions will take place on the mailing - lists, so it is important for all contributors - to follow the traffic. -

    - -

    Instant messaging / chat

    - -

    - Contributors to libvirt are encouraged to join the - IRC channel used by - the project, where they can have live conversations - with others members. -

    - -

    Student / outreach coding programs

    - -

    - Since 2016, the libvirt project directly participates as an - organization in the Google Summer of Code program. Prior to - this the project had a number of students in the program - via a joint application with the QEMU project. People are - encouraged to look at both the libvirt and QEMU programs - to identify potentially interesting projects to work on. -

    - - - diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 0000000000..c95c8b59d2 --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,105 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Contributing to libvirt +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This page provides guidance on how to contribute to the libvirt project. + +.. contents:: + +Contributions required +---------------------- + +The libvirt project is always looking for new contributors to participate = in +ongoing activities. While code development is a major part of the project, +assistance is needed in many other areas including documentation writing, = bug +triage, testing, application integration, website / wiki content managemen= t, +translation, branding, social media and more. The only requirement is an +interest in virtualization and desire to help. + +The following is a non-exhaustive list of areas in which people can contri= bute +to libvirt. If you have ideas for other contributions feel free to follow = them. + +- **Software development**. The official upstream code are kept in variou= s `Git + repositories `__. The core library / daemo= n (and + thus the bulk of coding) is written in C, but there are language bindin= gs + written in Python, Perl, Java, Ruby, Php, OCaml and Go. There are also = higher + level wrappers mapping libvirt into other object frameworks, such GLib,= CIM + and SNMP. For those interested in working on the core parts of libvirt,= the + `contributor guidelines `__ are mandatory reading +- **Translation**. All the libvirt modules aim to support translations wh= ere + appropriate. All translation is handling outside of the normal libvirt = review + process, using the `Fedora + instance = `__ of + the Weblate tool. Thus people wishing to contribute to translation shou= ld + join the Fedora translation team +- **Documentation**. There are docbook guides on various aspects of libvi= rt, + particularly application development guides for the C library and Pytho= n, and + a virsh command reference. There is thus scope for work by people who a= re + familiar with using or developing against libvirt, to write further con= tent + for these guides. There is also a need for people to review existing co= ntent + for copy editing and identifying gaps in the docs +- **Website / wiki curation**. The bulk of the website is maintained in t= he + primary GIT repository, while the wiki site uses mediawiki. In both cas= es + there is a need for people to both write new content and curate existing + content to identify outdated information, improve its organization and = target + gaps. +- **Testing**. There are a number of tests suites that can run automated = tests + against libvirt. The coverage of the tests is never complete, so there = is a + need for people to create new test suites and / or provide environments= to + actually run the tests in a variety of deployment scenarios. +- **Code analysis**. The libvirt project has access to the coverity tool = to run + static analysis against the codebase, however, there are other types of= code + analysis that can be useful. In particular fuzzing of the inputs can be= very + effective at identifying problematic edge cases. +- **Security handling**. Downstream (operating system) vendors who distri= bute + libvirt may wish to propose a person to be part of the security handling + team, to get early access to information about forthcoming vulnerability + fixes. +- **Evangelism**. Work done by the project is of no benefit unless the + (potential) user community knows that it exists. Thus it is critically + important to the health and future growth of the project, that there ar= e a + people who evangelize the work created by the project. This can take ma= ny + forms, writing blog posts (about usage of features, personal user + experiences, areas for future work, and more), syndicating docs and blo= gs via + social media, giving user group and/or conference talks about libvirt. +- **User assistance**. Since documentation is never perfect, there are + inevitably cases where users will struggle to attain a deployment goal = they + have, or run into trouble with managing an existing deployment. While s= ome + users may be able to contact a software vendor to obtain support, it is + common to rely on community help forums such as `libvirt users mailing + list `__, or sites such as + `stackoverflow. `__ + People who are familiar with libvirt and have ability & desire to help = other + users are encouraged to participate in these help forums. + +Communication +------------- + +For full details on contacting other project contributors read the +`contact `__ page. There are two main channels that libvirt = uses +for communication between contributors: + +Mailing lists +~~~~~~~~~~~~~ + +The project has a number of `mailing lists `__ for gen= eral +communication between contributors. In general any design discussions and = review +of contributions will take place on the mailing lists, so it is important = for +all contributors to follow the traffic. + +Instant messaging / chat +~~~~~~~~~~~~~~~~~~~~~~~~ + +Contributors to libvirt are encouraged to join the `IRC +channel `__ used by the project, where they can have live +conversations with others members. + +Student / outreach coding programs +---------------------------------- + +Since 2016, the libvirt project directly participates as an organization i= n the +`Google Summer of Code +program `__. Pr= ior to +this the project had a number of students in the program via a joint appli= cation +with the QEMU project. People are encouraged to look at both the libvirt a= nd +QEMU programs to identify potentially interesting projects to work on. diff --git a/docs/meson.build b/docs/meson.build index a719c268f6..bee7b3e6fc 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -22,7 +22,6 @@ docs_html_in_files =3D [ 'bugs', 'cgroups', 'contact', - 'contribute', 'csharp', 'dbus', 'docs', @@ -89,6 +88,7 @@ docs_rst_files =3D [ 'coding-style', 'committer-guidelines', 'compiling', + 'contribute', 'daemons', 'developer-tooling', 'drvqemu', --=20 2.35.1