libvirt/docs/index.rst
Erik Skultety 4e381c3e1d docs: index: Add a quick link to Submitting patches
We still get MRs in Gitlab from individual contributors on a regular
basis which in some ways just makes maintainer's or reviewer's life
just a bit more complicated. This ultimately means our guidelines are
probably not visible enough on the main page
(or some people wouldn't read them anyway). While this patch can't make
the problem go away, it can at least attempt to mitigate it by creating
a quick link to the 'hacking' page, skipping a lot of TL;DR contents
in contributing.rst which we link from the main page.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
Reviewed-by: Kristina Hanicova <khanicov@redhat.com>
2023-08-11 14:57:51 +02:00

76 lines
2.4 KiB
ReStructuredText

======================
The virtualization API
======================
Introduction
------------
The libvirt project:
- is a toolkit to manage `virtualization platforms <platforms.html>`__
- is accessible from C, Python, Perl, Go and more
- is licensed under open source licenses
- supports
`KVM <drvqemu.html>`__,
`Hypervisor.framework <drvqemu.html>`__,
`QEMU <drvqemu.html>`__,
`Xen <drvxen.html>`__,
`Virtuozzo <drvvirtuozzo.html>`__,
`VMWare ESX <drvesx.html>`__,
`LXC <drvlxc.html>`__,
`BHyve <drvbhyve.html>`__ and
`more <drivers.html>`__
- targets Linux, FreeBSD, `Windows <windows.html>`__ and `macOS <macos.html>`__
- is used by many `applications <apps.html>`__
Recent / forthcoming `release changes <news.html>`__
Quick Links
-----------
`New contributors <contribute.html>`__
Get involved in the libvirt community & student outreach programs
`Submitting patches <hacking.html>`__
Already a regular open source contributor and have git set up? Have a quick
look at how to propose your changes to libvirt correctly
`Security vulnerabilities <securityprocess.html>`__
View security notices and report vulnerabilities to the libvirt security
response team
`Bug reporting <bugs.html>`__
View and report bugs in libvirt packages
`XML configuration <format.html>`__
Description of the XML schemas for
`domains <formatdomain.html>`__,
`networks <formatnetwork.html>`__,
`network filtering <formatnwfilter.html>`__,
`storage <formatstorage.html>`__,
`storage encryption <formatstorageencryption.html>`__,
`capabilities <formatcaps.html>`__,
`domain capabilities <formatdomaincaps.html>`__,
`storage pool capabilities <formatstoragecaps.html>`__,
`node devices <formatnode.html>`__,
`secrets <formatsecret.html>`__,
`snapshots <formatsnapshot.html>`__,
`checkpoints <formatcheckpoint.html>`__,
`backup jobs <formatbackup.html>`__
`Wiki <https://wiki.libvirt.org>`__
Read further community contributed content
`Knowledge base <kbase/index.html>`__
Learn more about libvirt through knowledge base
`Documentation <docs.html>`__
Comprehensive documentation map
Blog Planet
-----------
.. raw:: html
<script type="text/javascript">
<!--
window.addEventListener("load", function() { fetchRSS() });
// -->
</script>
<div id="planet"> </div>
Read more on the `Virt Tools blog planet <https://planet.virt-tools.org/>`__