libvirt/docs
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
..
css css: Remove override of width for 'hvsupport' page 2023-05-18 10:06:51 +02:00
fonts meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
gitdm gitdm: Add other email into Red Hat company list 2021-10-12 16:46:45 +02:00
go docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
html meson: Annotate each test() with 'suite' 2023-07-20 10:58:01 +02:00
images meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
js meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
kbase docs: fix changed API calls 2023-06-05 13:34:31 +00:00
logos meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
manpages virsh: Add migrate options to set parallel compress level 2023-05-18 15:47:30 +02:00
404.rst docs: Convert 404 page to rST 2023-02-21 10:58:59 +01:00
acl.rst docs: acl: Convert to 'rst' 2023-05-17 16:54:23 +02:00
aclpolkit.rst docs: acl: Convert to 'rst' 2023-05-17 16:54:23 +02:00
advanced-tests.rst meson: Annotate each test() with 'suite' 2023-07-20 10:58:01 +02:00
android-chrome-192x192.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
android-chrome-256x256.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
api_extension.rst docs: Update obsolete reference to formatdomain.html.in 2022-03-22 11:05:09 +01:00
api.rst docs: Remove extra leading slash in 'api' and 'formatdomaincaps' pages 2022-06-01 12:27:10 +02:00
apple-touch-icon.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
apps.rst docs: apps: Add a new section for backup utilities and mention 'virtnbdbackup' 2023-04-03 11:09:39 +02:00
auditlog.rst docs: html.in: Convert auditlog to rst 2021-03-15 17:31:57 +01:00
auth.rst docs: auth: Fix a couple of stylistic issues 2021-03-23 17:55:06 +01:00
best-practices.rst docs: Update best practices wrt "Fixes:" and GitLab 2022-10-25 08:37:28 +02:00
bindings.rst docs: Link to java.libvirt.org 2023-04-27 11:06:42 +02:00
browserconfig.xml docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
bugs.rst docs: bugs: Remove raw HTML anchor 'quality' 2022-04-25 16:33:01 +02:00
cgroups.rst docs: Convert 'cgroups' page to rST 2022-04-01 16:33:19 +02:00
ci-dashboard.rst docs: Move the CI dashboard to its own RST module 2022-07-14 17:31:21 +02:00
ci-runners.rst docs: Provide an article on how to add a custom runner to the project 2022-07-14 17:31:21 +02:00
ci.rst docs: ci: Add a brief section on how to run the CI workload locally 2022-07-15 08:26:38 +02:00
clangd.rst docs: expand clangd instructions 2023-07-17 10:43:29 -05:00
coding-style.rst coding style: Follow our own rule on comment style 2023-04-04 12:16:09 +02:00
committer-guidelines.rst meson: adjust our documentation to mention meson instead of autoconf 2020-08-03 09:27:09 +02:00
compiling.rst docs: Reword ninja invocation note to clarify build directory 2023-07-14 15:19:34 +02:00
contact.rst docs: update links to listman 2022-06-22 15:29:44 +02:00
contribute.rst docs: Missing "full-stop"/"period" on some bullet items 2023-07-14 15:19:10 +02:00
csharp.rst docs: convert 'csharp' page to rst 2022-04-07 15:10:26 +02:00
daemons.rst docs: Move 'tlscerts' page to 'kbase/' 2022-04-07 15:10:26 +02:00
dbus.rst docs: convert 'dbus' page to rst 2022-04-07 15:10:26 +02:00
docs.rst docs: Link to java.libvirt.org 2023-04-27 11:06:42 +02:00
downloads.rst docs: downloads: Update link to 'Changes' of the libvirt-perl project 2023-04-03 09:19:05 +02:00
drivers.rst docs: drivers: Mention KVM/HVF in the link of qemu driver 2022-05-19 10:10:31 +02:00
drvbhyve.rst docs: drvbhve: Fix local anchor links 2022-04-19 16:19:48 +02:00
drvch.rst Add basic driver for the Cloud-Hypervisor 2021-06-04 10:56:06 +01:00
drvesx.rst Correct links to TLS certificate setup page 2022-04-25 16:33:01 +02:00
drvhyperv.rst docs: Update various URLs 2022-05-24 12:19:16 +02:00
drvlxc.rst docs: formatdomain: Remove 'elementsOSContainer' anchor 2022-06-01 12:27:09 +02:00
drvnodedev.rst docs: Convert 'formatnode' page to rst 2022-04-19 16:19:48 +02:00
drvopenvz.rst docs: Convert 'drvopenvz' page to rST 2022-04-01 16:33:19 +02:00
drvqemu.rst docs: drvqemu: Fix a typo 2023-01-12 11:40:21 +01:00
drvsecret.rst docs: Convert 'drvsecret' page to rST 2022-04-01 16:33:19 +02:00
drvtest.rst docs: Convert 'drvtest' page to rST 2022-04-01 16:33:19 +02:00
drvvbox.rst vbox: Drop support for virtualbox-6.0.0 2023-01-24 10:24:07 +01:00
drvvirtuozzo.rst docs: Convert 'drvvirtuozzo' page to rST 2022-04-01 16:33:19 +02:00
drvvmware.rst docs: Convert 'drvvmware' page to rST 2022-04-01 16:33:19 +02:00
drvxen.rst docs: Convert 'drvxen' page to rST 2022-04-01 16:33:19 +02:00
errors.rst docs: Convert 'errors' page to rST 2022-03-08 17:40:47 +01:00
favicon-16x16.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
favicon-32x32.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
favicon.ico docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
firewall.rst docs: Convert 'formatnwfilter' page to rst 2022-04-19 16:19:48 +02:00
format.rst docs: Convert 'format' page to rST 2022-04-01 16:33:19 +02:00
formatbackup.rst docs: formatdomain: Remove 'elementsDisks' anchor 2022-06-01 12:27:09 +02:00
formatcaps.rst formatcaps: Update capabilities example 2022-12-12 17:08:07 +01:00
formatcheckpoint.rst docs: formatdomain: Remove 'elementsDisks' anchor 2022-06-01 12:27:09 +02:00
formatdomain.rst docs: formatdomain: Mention the QEMU requirement for discard_no_unref 2023-07-26 10:08:26 +02:00
formatdomaincaps.rst conf: domcaps: Add 'async-teardown' domain capability 2023-07-18 08:49:32 +02:00
formatnetwork.rst docs: fix syntax errors in IPv6 NAT example XML 2022-08-23 16:33:20 +01:00
formatnetworkport.rst docs: formatdomain: Remove 'elementsNICSDirect' anchor 2022-06-01 12:27:09 +02:00
formatnode.rst schema: nodedev: Fix schema attribute value for the 'vport_ops' capability 2022-09-01 13:11:09 +02:00
formatnwfilter.rst docs: Convert 'formatnwfilter' page to rst 2022-04-19 16:19:48 +02:00
formatsecret.rst docs: formatdomain: Remove 'elementsTpm' anchor 2022-06-01 12:27:10 +02:00
formatsnapshot.rst docs: formatdomain: Remove 'seclabel' anchor 2022-06-01 12:27:10 +02:00
formatstorage.rst Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
formatstoragecaps.rst docs: Convert 'formatstoragecaps' page to rST 2022-04-07 17:15:52 +02:00
formatstorageencryption.rst qemu: add luks-any encryption support for RBD images 2023-03-16 15:19:36 +01:00
glib-adoption.rst docs: glib-adoption: add string arrays and objects 2020-10-02 14:10:44 +02:00
goals.rst docs: Convert 'goals' to rST 2022-03-08 17:40:47 +01:00
golang.rst docs: Add sub-page for all golang modules 2023-02-15 12:38:45 +01:00
governance.rst docs: governance: Remove unused HTML anchors 2022-04-25 16:33:01 +02:00
hacking.rst docs: Advise running CI tests prior to submission 2023-07-14 15:19:24 +02:00
hooks.rst docs: Recommend better python3 shebang 2023-02-20 18:33:01 +01:00
index.rst docs: index: Add a quick link to Submitting patches 2023-08-11 14:57:51 +02:00
issue-handling.rst docs: Add article about handling upstream issues 2022-07-26 16:35:57 +02:00
libvirt-go-xml.rst docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
libvirt-go.rst docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
logging.rst docs: logging: Replace example by link to kbase/debuglogs.html 2022-04-01 16:33:20 +02:00
macos.rst docs: Add support page for libvirt on macOS 2022-01-25 16:54:44 +01:00
manifest.json docs: Fix syntax-check error 2017-08-02 15:00:28 -04:00
meson.build meson: Annotate each test() with 'suite' 2023-07-20 10:58:01 +02:00
migration.rst docs: Move all images to a subdirectory 2022-01-04 15:47:25 +01:00
mstile-150x150.png docs: add full set of "favicon" files to support modern clients 2017-08-02 17:00:11 +01:00
newapi.xsl docs: newapi: Remove unused 'docomponents' template 2023-06-02 09:39:10 +02:00
newreposetup.rst docs: Document CIRRUS_GITHUB_REPO variable 2020-06-11 12:03:41 +02:00
nss.rst docs: Convert 'nss' page to rST 2022-03-10 17:52:07 +01:00
page.xsl docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
pci-addresses.rst Fix spelling 2021-04-15 15:42:21 +02:00
pci-hotplug.rst docs: pci-hotplug: Fix local anchor links 2022-04-19 16:19:48 +02:00
platforms.rst docs: Fix spelling for Homebrew 2022-04-14 11:54:28 +02:00
programming-languages.rst Fix capitalization "CLang" -> "Clang" 2020-11-12 15:01:42 +01:00
python.rst docs: convert 'python' page to rst 2022-04-07 15:10:26 +02:00
remote.rst docs: remote: Fix anchor names in links to uri.html 2022-06-01 12:27:10 +02:00
securityprocess.rst docs: contact: Remove HTML anchors and adjust documents using them 2022-04-25 16:33:01 +02:00
site.xsl docs: Simplify passing of 'href_base' XSL variable 2022-04-12 12:53:32 +02:00
storage.rst Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
strategy.rst docs: Convert 'strategy' to rST 2022-03-08 17:40:47 +01:00
styleguide.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
submitting-patches.rst docs: Point to mailing list archives from submitting-patches 2023-07-14 15:19:27 +02:00
support.rst docs: Convert 'support' page to rST 2022-03-08 17:40:47 +01:00
testapi.rst docs: Update link to the php bindings project webpage 2023-04-03 09:19:05 +02:00
testing.rst docs: Fix typos 2022-07-18 11:10:55 +02:00
testtck.rst docs: Fix typos 2022-07-18 11:10:55 +02:00
uri.rst uri: Fix link to qemu KVM example config 2022-06-01 12:27:10 +02:00
windows.rst docs: Update URL for MinGW 2022-05-24 12:19:15 +02:00