docs: Update godoc URLs for Go packages

[libvirt PATCH] docs: Update godoc URLs for Go packages

Posted by Andrea Bolognani 4 years, 2 months ago

Since

  commit 201156ec6e65e08cdb04d6fdefe013652fb7fa87
  Author: Daniel P. Berrangé <berrange@redhat.com>
  Date:   Mon Dec 16 10:06:50 2019 +0000

    docs: add pages to support Go module package resolution

it's possible to use

  import "libvirt.org/libvirt-go"
  import "libvirt.org/libvirt-go-xml"

in Go programs, which will result in the Go packages being
fetched directly from libvirt.org instead of GitHub.

The godoc website offers the API documentation for the updated
imports, and that's where we should send users.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
---
 docs/downloads.html.in | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/downloads.html.in b/docs/downloads.html.in
index e84455ca04..d4b4701ee0 100644
--- a/docs/downloads.html.in
+++ b/docs/downloads.html.in
@@ -71,7 +71,7 @@
             <a href="https://github.com/libvirt/libvirt-go">github</a>
           </td>
           <td>
-            <a href="https://godoc.org/github.com/libvirt/libvirt-go">api ref</a>
+            <a href="https://godoc.org/libvirt.org/libvirt-go">api ref</a>
           </td>
         </tr>
         <tr>
@@ -206,7 +206,7 @@
             <a href="https://github.com/libvirt/libvirt-go-xml">github</a>
           </td>
           <td>
-            <a href="https://godoc.org/github.com/libvirt/libvirt-go-xml">api ref</a>
+            <a href="https://godoc.org/libvirt.org/libvirt-go-xml">api ref</a>
           </td>
         </tr>
         <tr>
-- 
2.24.1

Re: [libvirt PATCH] docs: Update godoc URLs for Go packages

Posted by Ján Tomko 4 years, 2 months ago

On Thu, Jan 30, 2020 at 06:15:14PM +0100, Andrea Bolognani wrote:
>Since
>
>  commit 201156ec6e65e08cdb04d6fdefe013652fb7fa87
>  Author: Daniel P. Berrangé <berrange@redhat.com>
>  Date:   Mon Dec 16 10:06:50 2019 +0000
>
>    docs: add pages to support Go module package resolution
>
>it's possible to use
>
>  import "libvirt.org/libvirt-go"
>  import "libvirt.org/libvirt-go-xml"
>
>in Go programs, which will result in the Go packages being
>fetched directly from libvirt.org instead of GitHub.
>
>The godoc website offers the API documentation for the updated
>imports, and that's where we should send users.
>
>Signed-off-by: Andrea Bolognani <abologna@redhat.com>
>---
> docs/downloads.html.in | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano