Preserve the 'irc' and 'email' anchors. Signed-off-by: Peter Krempa <pkre...@redhat.com> --- 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 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml";> - <body> - <h1>Contacting the project contributors</h1> - - <ul id="toc"></ul> - - <h2><a id="security">Security Issues</a></h2> - - <p> - If you think that an issue with libvirt may have security - implications, <strong>please do not</strong> publicly - report it in the bug tracker, mailing lists, or irc. Libvirt - has <a href="securityprocess.html">a dedicated process for handling (potential) security issues</a> - that should be used instead. So if your issue has security - implications, ignore the rest of this page and follow the - <a href="securityprocess.html">security process</a> instead. - </p> - - <h2><a id="email">Mailing lists</a></h2> - - <p> - There are three mailing-lists: - </p> - - <dl class="mail"> - <dt><a href="https://www.redhat.com/mailman/listinfo/libvir-list";>libvir-list@redhat.com</a> (for development)</dt> - <dd> - Archives at <a href="https://www.redhat.com/archives/libvir-list";>https://www.redhat.com/archives/libvir-list</a> - </dd> - <dd> - This is a high volume mailing list. It is a place for discussions - about the <strong>development</strong> of libvirt. - </dd> - <dd> - Topics for discussion include: - <ul> - <li>New features for libvirt</li> - <li>Bug fixing of libvirt</li> - <li>New hypervisor drivers</li> - <li>Development of language bindings for libvirt API</li> - <li>Testing and documentation of libvirt</li> - </ul> - </dd> - - <dt><a href="https://www.redhat.com/mailman/listinfo/libvirt-users";>libvirt-us...@redhat.com</a> (for users)</dt> - <dd> - Archives at <a href="https://www.redhat.com/archives/libvirt-users";>https://www.redhat.com/archives/libvirt-users</a> - </dd> - <dd> - This is a moderate volume mailing list. It is a place for discussions - involving libvirt <strong>users</strong>. - </dd> - <dd> - Topics for discussion include: - <ul> - <li>Usage of libvirt / virsh</li> - <li>Administration of libvirt</li> - <li>Deployment of libvirt with hypervisors</li> - <li>Development of applications on top of / using the libvirt API(s)</li> - <li>Any other topics along these lines</li> - </ul> - </dd> - - <dt><a href="https://www.redhat.com/mailman/listinfo/libvirt-announce";>libvirt-annou...@redhat.com</a> (for release notices)</dt> - <dd> - Archives at <a href="https://www.redhat.com/archives/libvirt-announce";>https://www.redhat.com/archives/libvirt-announce</a> - </dd> - <dd> - This is a low volume mailing list, with restricted posting, for - announcements of new libvirt releases. - </dd> - <dd> - Subscribe to just this if you want to be notified of new releases, - without subscribing to either of the other mailing lists. - </dd> - - </dl> - - <p> - 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. - </p> - <p> - 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 - <code>git format-patch</code> in a git repository clone. Further - useful information regarding developing libvirt and/or contributing is - available on our <a href="hacking.html">Contributor Guidelines</a> - page. - </p> - - <h2><a id="irc">IRC discussion</a></h2> - - <p> - Some of the libvirt developers may be found on IRC on the <a href="https://oftc.net";>OFTC IRC</a> - network. Use the settings: - </p> - <ul> - <li>server: irc.oftc.net</li> - <li>port: 6667 (the usual IRC port)</li> - <li>channel: #virt</li> - </ul> - <p> - 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. - </p> - - </body> -</html> 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 <securityprocess.html>`__ that should be used instead. So if your issue +has security implications, ignore the rest of this page and follow the `security +process <securityprocess.html>`__ instead. + +:anchor:`<a id="email"/>` + +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-us...@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-annou...@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 <hacking.html>`__ page. + +:anchor:`<a id="irc"/>` + +IRC discussion +-------------- + +Some of the libvirt developers may be found on IRC on the `OFTC +IRC <https://oftc.net>`__ 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', -- 2.35.1
