From 5042a5def6d2d088ed19b10a08e5f40b11b2c58d Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 16:09:32 +0100 Subject: [PATCH] docs: Convert 'contact' page to rST MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Preserve the 'irc' and 'email' anchors. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/contact.html.in | 116 ------------------------------------------- docs/contact.rst | 94 +++++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 95 insertions(+), 117 deletions(-) delete mode 100644 docs/contact.html.in create mode 100644 docs/contact.rst diff --git a/docs/contact.html.in b/docs/contact.html.in deleted file mode 100644 index ad95800b1b..0000000000 --- a/docs/contact.html.in +++ /dev/null @@ -1,116 +0,0 @@ - - - - -

Contacting the project contributors

- -
    - -

    Security Issues

    - -

    - If you think that an issue with libvirt may have security - implications, please do not publicly - report it in the bug tracker, mailing lists, or irc. Libvirt - has a dedicated process for handling (potential) security issues - that should be used instead. So if your issue has security - implications, ignore the rest of this page and follow the - security process instead. -

    - -

    Mailing lists

    - -

    - There are three mailing-lists: -

    - -
    -
    libvir-list@redhat.com (for development)
    -
    - Archives at https://www.redhat.com/archives/libvir-list -
    -
    - This is a high volume mailing list. It is a place for discussions - about the development of libvirt. -
    -
    - Topics for discussion include: -
      -
    • New features for libvirt
      • -
    • Bug fixing of libvirt
      • -
    • New hypervisor drivers
      • -
    • Development of language bindings for libvirt API
      • -
    • Testing and documentation of libvirt
      • -
    -
    - -
    libvirt-users@redhat.com (for users)
    -
    - Archives at https://www.redhat.com/archives/libvirt-users -
    -
    - This is a moderate volume mailing list. It is a place for discussions - involving libvirt users. -
    -
    - Topics for discussion include: -
      -
    • Usage of libvirt / virsh
      • -
    • Administration of libvirt
      • -
    • Deployment of libvirt with hypervisors
      • -
    • Development of applications on top of / using the libvirt API(s)
      • -
    • Any other topics along these lines
      • -
    -
    - -
    libvirt-announce@redhat.com (for release notices)
    -
    - Archives at https://www.redhat.com/archives/libvirt-announce -
    -
    - This is a low volume mailing list, with restricted posting, for - announcements of new libvirt releases. -
    -
    - Subscribe to just this if you want to be notified of new releases, - without subscribing to either of the other mailing lists. -
    - -
    - -

    - It is recommended but not required that you subscribe before posting - to the user and development lists. Posts from non-subscribers will be - subject to manual moderation delays. You can subscribe at the linked - web pages above. -

    -

    - Patches with explanations and provided as attachments are really - appreciated, and should be directed to the development mailing list - for review and discussion. - Wherever possible, please generate the patches by using - git format-patch in a git repository clone. Further - useful information regarding developing libvirt and/or contributing is - available on our Contributor Guidelines - page. -

    - -

    IRC discussion

    - -

    - Some of the libvirt developers may be found on IRC on the OFTC IRC - network. Use the settings: -

    -
      -
    • server: irc.oftc.net
      • -
    • port: 6667 (the usual IRC port)
      • -
    • channel: #virt
      • -
    -

    - NB There is no guarantee that someone will be watching or able to reply - promptly, so use the mailing-list if you don't get an answer on the IRC - channel. -

    - - - diff --git a/docs/contact.rst b/docs/contact.rst new file mode 100644 index 0000000000..75b1239301 --- /dev/null +++ b/docs/contact.rst @@ -0,0 +1,94 @@ +.. role:: anchor(raw) + :format: html + +=================================== +Contacting the project contributors +=================================== + +.. contents:: + +Security Issues +--------------- + +If you think that an issue with libvirt may have security implications, **please +do not** publicly report it in the bug tracker, mailing lists, or irc. Libvirt +has `a dedicated process for handling (potential) security +issues `__ that should be used instead. So if your issue +has security implications, ignore the rest of this page and follow the `security +process `__ instead. + +:anchor:`` + +Mailing lists +------------- + +There are three mailing-lists: + +**libvir-list@redhat.com** (for development) + Archives + https://www.redhat.com/archives/libvir-list + List info + https://www.redhat.com/mailman/listinfo/libvir-list + + This is a high volume mailing list. It is a place for discussions about the + **development** of libvirt. + Topics for discussion include: + + - New features for libvirt + - Bug fixing of libvirt + - New hypervisor drivers + - Development of language bindings for libvirt API + - Testing and documentation of libvirt + +**libvirt-users@redhat.com** (for users) + Archives + https://www.redhat.com/archives/libvirt-users + List info + https://www.redhat.com/mailman/listinfo/libvirt-users + + This is a moderate volume mailing list. It is a place for discussions + involving libvirt **users**. + Topics for discussion include: + + - Usage of libvirt / virsh + - Administration of libvirt + - Deployment of libvirt with hypervisors + - Development of applications on top of / using the libvirt API(s) + - Any other topics along these lines + +**libvirt-announce@redhat.com** (for release notices) + Archives + https://www.redhat.com/archives/libvirt-announce + List info + https://www.redhat.com/mailman/listinfo/libvirt-announce + + This is a low volume mailing list, with restricted posting, for announcements + of new libvirt releases. + Subscribe to just this if you want to be notified of new releases, without + subscribing to either of the other mailing lists. + +It is recommended but not required that you subscribe before posting to the user +and development lists. Posts from non-subscribers will be subject to manual +moderation delays. You can subscribe at the linked web pages above. + +Patches with explanations and provided as attachments are really appreciated, +and should be directed to the development mailing list for review and +discussion. Wherever possible, please generate the patches by using +``git format-patch`` in a git repository clone. Further useful information +regarding developing libvirt and/or contributing is available on our +`Contributor Guidelines `__ page. + +:anchor:`` + +IRC discussion +-------------- + +Some of the libvirt developers may be found on IRC on the `OFTC +IRC `__ network. Use the settings: + +- server: irc.oftc.net +- port: 6667 (the usual IRC port) +- channel: #virt + +NB There is no guarantee that someone will be watching or able to reply +promptly, so use the mailing-list if you don't get an answer on the IRC channel. diff --git a/docs/meson.build b/docs/meson.build index c1d4072cf7..aaafa7d8e1 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -20,7 +20,6 @@ docs_assets = [ docs_html_in_files = [ '404', 'cgroups', - 'contact', 'csharp', 'dbus', 'docs', @@ -81,6 +80,7 @@ docs_rst_files = [ 'coding-style', 'committer-guidelines', 'compiling', + 'contact', 'contribute', 'daemons', 'developer-tooling',