diff mbox series

[qemu-web,6/7] Add link to "edit this page" for all pages

Message ID 20201023152957.488974-7-berrange@redhat.com
State New
Headers show
Series Tweaks to page footer and add "edit page" links | expand

Commit Message

Daniel P. Berrangé Oct. 23, 2020, 3:29 p.m. UTC
The link takes the user directly to the source markdown file in gitlab,
where they can press the "Edit" button and make changes directly in the
browser. They will be prompted to fork the project when committing the
changes if they don't already have a fork.  The result is a commit which
can be submitted for review per the contributing guidelines.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 _includes/footer.html        | 3 +++
 assets/css/style-desktop.css | 4 ++++
 assets/css/style.css         | 2 +-
 3 files changed, 8 insertions(+), 1 deletion(-)

Comments

Paolo Bonzini Oct. 23, 2020, 3:47 p.m. UTC | #1
On 23/10/20 17:29, Daniel P. Berrangé wrote:
> The link takes the user directly to the source markdown file in gitlab,

> where they can press the "Edit" button and make changes directly in the

> browser. They will be prompted to fork the project when committing the

> changes if they don't already have a fork.  The result is a commit which

> can be submitted for review per the contributing guidelines.

> 

> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>


I think this is a good idea *if* we switch to merge requests for website
edits---which isn't something I'm opposed to.

Paolo

> ---

>  _includes/footer.html        | 3 +++

>  assets/css/style-desktop.css | 4 ++++

>  assets/css/style.css         | 2 +-

>  3 files changed, 8 insertions(+), 1 deletion(-)

> 

> diff --git a/_includes/footer.html b/_includes/footer.html

> index 2dd247b..0a77d8e 100644

> --- a/_includes/footer.html

> +++ b/_includes/footer.html

> @@ -1,4 +1,7 @@

>  <div id="footer">

> +	<div id="edit-page">

> +		<a href="https://gitlab.com/qemu-project/qemu-web/-/blob/master/{{page.path}}">edit this page</a>

> +	</div>

>  	<div id="external-links">

>  		<ul class="style">

>  			<li><a href="http://qemu-advent-calendar.org">Advent calendar</a></li>

> diff --git a/assets/css/style-desktop.css b/assets/css/style-desktop.css

> index d45ec15..19272ad 100644

> --- a/assets/css/style-desktop.css

> +++ b/assets/css/style-desktop.css

> @@ -102,6 +102,10 @@

>  /* Footer                                                                        */

>  /*********************************************************************************/

>  

> +	#edit-page {

> +		text-align: right;

> +	}

> +

>  	#licenses {

>  		float: right;

>  	}

> diff --git a/assets/css/style.css b/assets/css/style.css

> index e2fee29..50bbcd1 100644

> --- a/assets/css/style.css

> +++ b/assets/css/style.css

> @@ -514,7 +514,7 @@

>  		margin: 0em;

>  	}

>  

> -	#conservancy, #licenses {

> +	#conservancy, #licenses, #edit-page {

>  		padding: 0em;

>  		padding-left: 1em;

>  		padding-right: 1em;

>
Daniel P. Berrangé Oct. 23, 2020, 4:19 p.m. UTC | #2
On Fri, Oct 23, 2020 at 05:47:45PM +0200, Paolo Bonzini wrote:
> On 23/10/20 17:29, Daniel P. Berrangé wrote:

> > The link takes the user directly to the source markdown file in gitlab,

> > where they can press the "Edit" button and make changes directly in the

> > browser. They will be prompted to fork the project when committing the

> > changes if they don't already have a fork.  The result is a commit which

> > can be submitted for review per the contributing guidelines.

> > 

> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

> 

> I think this is a good idea *if* we switch to merge requests for website

> edits---which isn't something I'm opposed to.


Note if you disable merge requests, then the page we link to doesn't
show a live editor. It merely shows the read-only source. Not as
useful, at least the user can see which source file they need to
touch in their fork, which is still a step forwards I think.

> 

> Paolo

> 

> > ---

> >  _includes/footer.html        | 3 +++

> >  assets/css/style-desktop.css | 4 ++++

> >  assets/css/style.css         | 2 +-

> >  3 files changed, 8 insertions(+), 1 deletion(-)

> > 

> > diff --git a/_includes/footer.html b/_includes/footer.html

> > index 2dd247b..0a77d8e 100644

> > --- a/_includes/footer.html

> > +++ b/_includes/footer.html

> > @@ -1,4 +1,7 @@

> >  <div id="footer">

> > +	<div id="edit-page">

> > +		<a href="https://gitlab.com/qemu-project/qemu-web/-/blob/master/{{page.path}}">edit this page</a>

> > +	</div>

> >  	<div id="external-links">

> >  		<ul class="style">

> >  			<li><a href="http://qemu-advent-calendar.org">Advent calendar</a></li>

> > diff --git a/assets/css/style-desktop.css b/assets/css/style-desktop.css

> > index d45ec15..19272ad 100644

> > --- a/assets/css/style-desktop.css

> > +++ b/assets/css/style-desktop.css

> > @@ -102,6 +102,10 @@

> >  /* Footer                                                                        */

> >  /*********************************************************************************/

> >  

> > +	#edit-page {

> > +		text-align: right;

> > +	}

> > +

> >  	#licenses {

> >  		float: right;

> >  	}

> > diff --git a/assets/css/style.css b/assets/css/style.css

> > index e2fee29..50bbcd1 100644

> > --- a/assets/css/style.css

> > +++ b/assets/css/style.css

> > @@ -514,7 +514,7 @@

> >  		margin: 0em;

> >  	}

> >  

> > -	#conservancy, #licenses {

> > +	#conservancy, #licenses, #edit-page {

> >  		padding: 0em;

> >  		padding-left: 1em;

> >  		padding-right: 1em;

> > 

> 

> 


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 :|
Paolo Bonzini Oct. 23, 2020, 5:07 p.m. UTC | #3
On 23/10/20 18:19, Daniel P. Berrangé wrote:
>> I think this is a good idea *if* we switch to merge requests for website

>> edits---which isn't something I'm opposed to.

> Note if you disable merge requests, then the page we link to doesn't

> show a live editor. It merely shows the read-only source. Not as

> useful, at least the user can see which source file they need to

> touch in their fork, which is still a step forwards I think.

> 


I agree, so I think if you change it to "View source" it's okay.

Paolo
diff mbox series

Patch

diff --git a/_includes/footer.html b/_includes/footer.html
index 2dd247b..0a77d8e 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -1,4 +1,7 @@ 
 <div id="footer">
+	<div id="edit-page">
+		<a href="https://gitlab.com/qemu-project/qemu-web/-/blob/master/{{page.path}}">edit this page</a>
+	</div>
 	<div id="external-links">
 		<ul class="style">
 			<li><a href="http://qemu-advent-calendar.org">Advent calendar</a></li>
diff --git a/assets/css/style-desktop.css b/assets/css/style-desktop.css
index d45ec15..19272ad 100644
--- a/assets/css/style-desktop.css
+++ b/assets/css/style-desktop.css
@@ -102,6 +102,10 @@ 
 /* Footer                                                                        */
 /*********************************************************************************/
 
+	#edit-page {
+		text-align: right;
+	}
+
 	#licenses {
 		float: right;
 	}
diff --git a/assets/css/style.css b/assets/css/style.css
index e2fee29..50bbcd1 100644
--- a/assets/css/style.css
+++ b/assets/css/style.css
@@ -514,7 +514,7 @@ 
 		margin: 0em;
 	}
 
-	#conservancy, #licenses {
+	#conservancy, #licenses, #edit-page {
 		padding: 0em;
 		padding-left: 1em;
 		padding-right: 1em;