libvirt/docs
Daniel P. Berrangé 201156ec6e docs: add pages to support Go module package resolution
Currently the libvirt Go modules are accessed by applications using
their github repository URLs. This is undesirable as we don't want
applications to have a direct dependancy on a specific source repo
location. We want to enable applications to use the Go packages via
the libvirt.org namespace.

When you do "go get libvirt.org/libvirt-go", the Go client will do an
HTTPS request to that URL, and parse the HTML content to look for a
<meta> tag which tells it where to the find the GIT repository.

   https://golang.org/cmd/go/#hdr-Remote_import_paths

This adds two pages to support this Go module resolution. They are
not linked from anywhere as we don't expect users to actually look
at them. If someone does happen upon them, there's some boilerplate
text to send them off to godoc.org for API documentation.

Since the pages we're adding have a .html extension, we will also
use a small apache config tweak on the server

    RewriteEngine on
    RewriteRule ^/libvirt-go$ /libvirt-go.html [L]
    RewriteRule ^/libvirt-go-xml$ /libvirt-go-xml.html [L]

Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-01-27 11:51:46 +00:00
..
fonts
gitdm gitdm: Add missing entries 2019-11-05 12:12:14 +01:00
html
internals util: purge all code for testing OOM handling 2019-09-13 10:05:17 +01:00
js
kbase kbase: Add document outlining backing chain XML config and troubleshooting 2019-12-18 09:36:49 +01:00
logos docs: add SVGs for sticker logos 2019-08-29 12:46:33 +01:00
manpages qemu: introduce a new "virt-qemu-run" program 2020-01-27 11:05:02 +00:00
schemas conf: Add rng backend model builtin 2020-01-24 17:03:32 +01:00
32favicon.png
404.html.in
acl.html.in
aclpolkit.html.in Remove phyp driver 2019-12-20 12:25:42 -05:00
android-chrome-192x192.png
android-chrome-256x256.png
api_extension.html.in docs: Make anchors follow HTML5 2019-08-28 13:39:26 +02:00
api.html.in Remove phyp driver 2019-12-20 12:25:42 -05:00
apple-touch-icon.png
apps.html.in docs: fixing typos 'libivrt' > 'libvirt' 2020-01-17 16:44:31 +01:00
architecture.fig
architecture.gif
architecture.html.in
auditlog.html.in docs: fixing typos 'libivrt' > 'libvirt' 2020-01-17 16:44:31 +01:00
auth.html.in docs/auth.html.in: fixed typos 2019-12-23 10:08:05 +00:00
bindings.html.in
browserconfig.xml
bugs.html.in
cgroups.html.in doc: cgroups: Remove unwanted references to systemd 2019-11-15 15:45:20 +01:00
compiling.html.in build: mandate use of a build dir != src dir 2019-11-08 17:07:35 +01:00
contact.html.in
contribute.html.in
csharp.html.in
dbus.html.in docs: Make anchors follow HTML5 2019-08-28 13:39:26 +02:00
devguide.html.in
docs.html.in docs: remove link to virsh cmd ref & app dev guide 2019-12-13 13:55:35 +00:00
downloads.html.in
drivers.html.in secrets: add support for running secret driver in embedded mode 2020-01-27 11:04:29 +00:00
drvbhyve.html.in
drvesx.html.in docs: mention lifted vCPUs restriction for esx 2019-11-14 14:55:56 +01:00
drvhyperv.html.in
drvlxc.html.in
drvnodedev.html.in
drvopenvz.html.in
drvqemu.html.in qemu: add support for running QEMU driver in embedded mode 2020-01-27 11:04:03 +00:00
drvremote.html.in
drvsecret.html.in secrets: add support for running secret driver in embedded mode 2020-01-27 11:04:29 +00:00
drvtest.html.in
drvvbox.html.in
drvvirtuozzo.html.in
drvvmware.html.in
drvxen.html.in
errors.html.in
favicon-16x16.png
favicon-32x32.png
favicon.ico
firewall.html.in
format.html.in backup: Document new XML for backups 2019-12-10 12:41:56 +01:00
formatbackup.html.in conf: backup: Allow configuration of names exported via NBD 2020-01-24 13:40:48 +01:00
formatcaps.html.in conf: add support for specifying CPU "dies" parameter 2020-01-16 15:11:42 +00:00
formatcheckpoint.html.in backup: Document new XML for backups 2019-12-10 12:41:56 +01:00
formatdomain.html.in conf: Add rng backend model builtin 2020-01-24 17:03:32 +01:00
formatdomaincaps.html.in conf: Add rng backend model builtin 2020-01-24 17:03:32 +01:00
formatnetwork.html.in
formatnetworkport.html.in
formatnode.html.in
formatnwfilter.html.in
formatsecret.html.in doc: vtpm only support secrets by UUID at this point 2019-12-11 11:34:12 -05:00
formatsnapshot.html.in
formatstorage.html.in
formatstoragecaps.html.in
formatstorageencryption.html.in
generic.css docs: add styling for <tt> element 2019-12-04 15:48:28 +00:00
goals.html.in
governance.html.in
hacking.html.in docs: hacking: document removal of VIR_STR(N)DUP 2019-12-12 14:24:35 +01:00
hooks.html.in
index.html.in backup: Document new XML for backups 2019-12-10 12:41:56 +01:00
internals.html.in
java.html.in
kbase.html.in kbase: Add document outlining backing chain XML config and troubleshooting 2019-12-18 09:36:49 +01:00
libvirt-daemon-arch.fig
libvirt-daemon-arch.png
libvirt-driver-arch.fig
libvirt-driver-arch.png
libvirt-go-xml.rst docs: add pages to support Go module package resolution 2020-01-27 11:51:46 +00:00
libvirt-go.rst docs: add pages to support Go module package resolution 2020-01-27 11:51:46 +00:00
libvirt-object-model.fig
libvirt-object-model.png
libvirt-virConnect-example.fig
libvirt-virConnect-example.png
libvirt.css docs: relax CSS context match for pretty tables 2019-12-04 15:48:28 +00:00
logging.html.in util: drop support for stack traces with logging 2019-10-18 16:25:17 +01:00
main.css
Makefile.am qemu: introduce a new "virt-qemu-run" program 2020-01-27 11:05:02 +00:00
manifest.json
migration-managed-direct.fig
migration-managed-direct.png
migration-managed-p2p.fig
migration-managed-p2p.png
migration-native.fig
migration-native.png
migration-tunnel.fig
migration-tunnel.png
migration-unmanaged-direct.fig
migration-unmanaged-direct.png
migration.html.in docs: relax CSS context match for pretty tables 2019-12-04 15:48:28 +00:00
mobile.css
mstile-150x150.png
newapi.xsl docs: relax CSS context match for pretty tables 2019-12-04 15:48:28 +00:00
news-2005.html.in
news-2006.html.in
news-2007.html.in
news-2008.html.in
news-2009.html.in
news-2010.html.in
news-2011.html.in
news-2012.html.in
news-2013.html.in
news-2014.html.in
news-2015.html.in
news-2016.html.in
news-ascii.xsl
news-html.xsl
news.rng
news.xml news: Update news for rng backend type builtin 2020-01-24 17:03:38 +01:00
node.fig
node.gif
nss.html.in
page.xsl docs: add pages to support Go module package resolution 2020-01-27 11:51:46 +00:00
pci-hotplug.html.in
php.html.in
platforms.html.in docs: expand macOS platform support coverage 2020-01-03 15:42:12 +00:00
python.html.in
remote.html.in docs: move docs about remote driver URIs into URI docs 2019-12-04 15:48:28 +00:00
securityprocess.html.in
site.xsl
storage.html.in storage: add vmfs filesystem type 2019-12-20 14:31:08 +01:00
strategy.html.in docs: attempt to document the general libvirt dev strategy 2019-10-01 13:08:01 +01:00
structures.fig
styleguide.rst docs: describe the basic RST structure for a man page 2019-12-11 14:28:41 +00:00
subsite.xsl
support.html.in
testapi.html.in
testsuites.html.in
testtck.html.in
tlscerts.html.in docs: split TLS certificate setup into its own file 2019-12-04 15:48:28 +00:00
uri.html.in docs: move docs about remote driver URIs into URI docs 2019-12-04 15:48:28 +00:00
virshcmdref.html.in
windows.html.in build: mandate use of a build dir != src dir 2019-11-08 17:07:35 +01:00
wrapstring.xsl