docs: replace 'Edit on GitLab' with 'View page source'

[PATCH] docs: replace 'Edit on GitLab' with 'View page source'

Posted by Daniel P. Berrangé 4 months ago

QEMU takes contributions via the mailing list, so while you can edit a
file on gitlab and then switch to the terminal to send a patch, the
wording 'Edit on GitLab' strongly suggests we take merge requests.

Switching back to "View page source" is a more agnostic term that does
not imply a particular contribution approach, that we had used in QEMU
before:

  commit 73e6aec6522e1edd63f631c52577b49a39bc234f
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   Tue Mar 23 15:53:28 2021 +0400

    sphinx: adopt kernel readthedoc theme

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index c11a6ead8a..164a8ee8b2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -186,7 +186,7 @@
 ]
 
 html_context = {
-    "display_gitlab": True,
+    "source_url_prefix": "https://gitlab.com/qemu-project/qemu/-/blob/master/docs/",
     "gitlab_user": "qemu-project",
     "gitlab_repo": "qemu",
     "gitlab_version": "master",
-- 
2.46.0

Re: [PATCH] docs: replace 'Edit on GitLab' with 'View page source'

Posted by Pierrick Bouvier 4 months ago

On 12/9/24 08:35, Daniel P. Berrangé wrote:
> QEMU takes contributions via the mailing list, so while you can edit a
> file on gitlab and then switch to the terminal to send a patch, the
> wording 'Edit on GitLab' strongly suggests we take merge requests.
> 
> Switching back to "View page source" is a more agnostic term that does
> not imply a particular contribution approach, that we had used in QEMU
> before:
> 
>    commit 73e6aec6522e1edd63f631c52577b49a39bc234f
>    Author: Marc-André Lureau <marcandre.lureau@redhat.com>
>    Date:   Tue Mar 23 15:53:28 2021 +0400
> 
>      sphinx: adopt kernel readthedoc theme
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   docs/conf.py | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/conf.py b/docs/conf.py
> index c11a6ead8a..164a8ee8b2 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -186,7 +186,7 @@
>   ]
>   
>   html_context = {
> -    "display_gitlab": True,
> +    "source_url_prefix": "https://gitlab.com/qemu-project/qemu/-/blob/master/docs/",
>       "gitlab_user": "qemu-project",
>       "gitlab_repo": "qemu",
>       "gitlab_version": "master",

Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>

Re: [PATCH] docs: replace 'Edit on GitLab' with 'View page source'

Posted by Philippe Mathieu-Daudé 4 months ago

On 9/12/24 17:35, Daniel P. Berrangé wrote:
> QEMU takes contributions via the mailing list, so while you can edit a
> file on gitlab and then switch to the terminal to send a patch, the
> wording 'Edit on GitLab' strongly suggests we take merge requests.
> 
> Switching back to "View page source" is a more agnostic term that does
> not imply a particular contribution approach, that we had used in QEMU
> before:
> 
>    commit 73e6aec6522e1edd63f631c52577b49a39bc234f
>    Author: Marc-André Lureau <marcandre.lureau@redhat.com>
>    Date:   Tue Mar 23 15:53:28 2021 +0400
> 
>      sphinx: adopt kernel readthedoc theme
> 

Is this:
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/2709
?

> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   docs/conf.py | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/conf.py b/docs/conf.py
> index c11a6ead8a..164a8ee8b2 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -186,7 +186,7 @@
>   ]
>   
>   html_context = {
> -    "display_gitlab": True,
> +    "source_url_prefix": "https://gitlab.com/qemu-project/qemu/-/blob/master/docs/",
>       "gitlab_user": "qemu-project",
>       "gitlab_repo": "qemu",
>       "gitlab_version": "master",

Re: [PATCH] docs: replace 'Edit on GitLab' with 'View page source'

Posted by Daniel P. Berrangé 4 months ago

On Mon, Dec 09, 2024 at 05:38:49PM +0100, Philippe Mathieu-Daudé wrote:
> On 9/12/24 17:35, Daniel P. Berrangé wrote:
> > QEMU takes contributions via the mailing list, so while you can edit a
> > file on gitlab and then switch to the terminal to send a patch, the
> > wording 'Edit on GitLab' strongly suggests we take merge requests.
> > 
> > Switching back to "View page source" is a more agnostic term that does
> > not imply a particular contribution approach, that we had used in QEMU
> > before:
> > 
> >    commit 73e6aec6522e1edd63f631c52577b49a39bc234f
> >    Author: Marc-André Lureau <marcandre.lureau@redhat.com>
> >    Date:   Tue Mar 23 15:53:28 2021 +0400
> > 
> >      sphinx: adopt kernel readthedoc theme
> > 
> 
> Is this:
> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/2709
> ?

I won't really claim it resolves that, as that issues is showing
lots of user confusion, most of which is not in our control.

> 
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > ---
> >   docs/conf.py | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/docs/conf.py b/docs/conf.py
> > index c11a6ead8a..164a8ee8b2 100644
> > --- a/docs/conf.py
> > +++ b/docs/conf.py
> > @@ -186,7 +186,7 @@
> >   ]
> >   html_context = {
> > -    "display_gitlab": True,
> > +    "source_url_prefix": "https://gitlab.com/qemu-project/qemu/-/blob/master/docs/",
> >       "gitlab_user": "qemu-project",
> >       "gitlab_repo": "qemu",
> >       "gitlab_version": "master",
> 

With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|