Skip to contentSkip to conversation

Tweaks to page footer and add "edit page" links

PATCH Superseded Daniel P. Berrangé 2 participants 15 messages Oct 23, 2020

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#2 lore raw

PATCH 2/7 gitlab: introduce a CI job to publish the site content

In reply to Daniel P. Berrangé
---
 .gitlab-ci.yml | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 .gitlab-ci.yml
.gitlab-ci.yml new file +16 -0
new file mode 100644
index 0000000..5fa3041
@@ -0,0 +1,16 @@
+
+pages:
+  image: centos:8
+  cache:
+    paths:
+      - vendor
+  before_script:
+    - dnf install -y ruby ruby-devel rubygem-bundler openssl-devel
+    - dnf install -y gcc gcc-c++ make redhat-rpm-config
+    - bundle install --path vendor
+  script:
+    - bundle exec jekyll build
+    - mv _site public
+  artifacts:
+    paths:
+     - public
Signature · 1 line
2.26.2
#13 lore raw

PATCH 7/7 Add a CONTRIBUTING.md file as guidance for contributors

In reply to Daniel P. Berrangé
---
 CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++
 _config.yml     |  1 +
 2 files changed, 33 insertions(+)
 create mode 100644 CONTRIBUTING.md
CONTRIBUTING.md new file +32 -0
new file mode 100644
index 0000000..0be58d8
@@ -0,0 +1,32 @@
+# Contributing to qemu-web
+
+The QEMU project accepts code contributions to the website as patches sent to
+the the developer mailing list:
+
+https://lists.nongnu.org/mailman/listinfo/qemu-devel
+
+For further guidance on sending patches consult:
+
+https://wiki.qemu.org/Contribute/SubmitAPatch
+
+It is expected that contributors check the rendered website before submitting
+patches. This is possible by either running jekyll locally, or by using the
+GitLab CI and Pages infrastructure.
+
+Any branch that is pushed to a GitLab fork will result in a CI job being run
+visible at
+
+https://gitlab.com/yourusername/libvirt-perl/pipelines
+
+The rendered result can be then viewed at
+
+https://yourusername.gitlab.io/qemu-web
+
+Contributions submitted to the project must be in compliance with the
+Developer Certificate of Origin Version 1.1. This is documented at:
+
+https://developercertificate.org/
+
+To indicate compliance, each commit in a series must have a "Signed-off-by"
+tag with the submitter's name and email address. This can be added by passing
+the ``-s`` flag to ``git commit`` when creating the patches.
_config.yml +1 -0
index d0473c1..7d34779 100644
@@ -40,3 +40,4 @@ exclude:
   - Gemfile.lock
   - vendor/
   - README
+  - CONTRIBUTING.md
Signature · 1 line
2.26.2
#1 lore raw

PATCH 1/7 Convert files to UNIX line endings

In reply to Daniel P. Berrangé
---
 assets/css/style-desktop.css |  586 ++++++++---------
 assets/css/style-mobile.css  |  750 ++++++++++-----------
 assets/css/style.css         | 1184 +++++++++++++++++-----------------
 index.html                   |  178 ++---
 4 files changed, 1349 insertions(+), 1349 deletions(-)
assets/css/style-desktop.css +293 -293
index b6c5aa1..ce58fe2 100644
@@ -1,295 +1,295 @@
-/*
-	Linear by TEMPLATED
-    templated.co @templatedco
-    Released for free under the Creative Commons Attribution 3.0 license (templated.co/license)
-*/
-
-/*********************************************************************************/
-/* Grid                                                                          */
-/*********************************************************************************/
-
-@import url(cells.css);
-
-	.row > * {
-		padding-left: 50px;
-	}	
-	.row > *:first-child {
-		padding-left: 0px;
-	}
-	.row + .row {
-		padding-top: 50px;
-	}	
-
-/*********************************************************************************/
-/* Basic                                                                         */
-/*********************************************************************************/
-
-	.only-mobile, .not-desktop
-	{
-		display: none !important;
-	}
-
-	body
-	{
-		/* 90% transparent */
-		background: url(../images/qemu_head_200.png) no-repeat fixed 2em 80px;
+/*
+	Linear by TEMPLATED
+    templated.co @templatedco
+    Released for free under the Creative Commons Attribution 3.0 license (templated.co/license)
+*/
+
+/*********************************************************************************/
+/* Grid                                                                          */
+/*********************************************************************************/
+
+@import url(cells.css);
+
+	.row > * {
+		padding-left: 50px;
+	}	
+	.row > *:first-child {
+		padding-left: 0px;
+	}
+	.row + .row {
+		padding-top: 50px;
+	}	
+
+/*********************************************************************************/
+/* Basic                                                                         */
+/*********************************************************************************/
+
+	.only-mobile, .not-desktop
+	{
+		display: none !important;
+	}
+
+	body
+	{
+		/* 90% transparent */
+		background: url(../images/qemu_head_200.png) no-repeat fixed 2em 80px;
 		background-color: #FFF;
-	}
-
-	body.homepage
-	{
-		/* 90% transparent */
-		background: url(../images/qemu_head_400_faint.png) no-repeat fixed center 60%;
+	}
+
+	body.homepage
+	{
+		/* 90% transparent */
+		background: url(../images/qemu_head_400_faint.png) no-repeat fixed center 60%;
 		background-color: #FFF;
-	}
-
-	body,input,textarea,select
-	{
-	}
-
-	.homepage h1
-	{
-		font-size: 7em;
-		letter-spacing: -0.05em;
-	}
-
-	.homepage h2
-	{
-		font-size: 2.2em;
-	}
-
-	h1
-	{
-		font-size: 3em;
-	}
-
-	header
-	{
-		margin-bottom: 2em;
-	}
-	
-		header .byline
-		{
-			font-size: 1.7em;
-		}
-
-/*********************************************************************************/
-/* Header                                                                        */
-/*********************************************************************************/
-
-	#header
-	{
-		padding: 5em 0 2em 0;
-	}
-
-/*********************************************************************************/
-/* Main                                                                          */
-/*********************************************************************************/
-
-	#main,#sidebar {
-		margin-top: 5em;
-	}
-
-	#sidebar h1
-	{
-		font-size: 2.4em;
-		letter-spacing: 0em;
-		line-height: 1.2em;
-		margin-top: -0.2em;
-	}
-
-/*********************************************************************************/
-/* Footer                                                                        */
-/*********************************************************************************/
-	
-	#footer
-	{
-		padding: 1em 0em;
-	}
-	
-	#footer-inner
-	{
-		width: 95%;
-		display: table;
-		margin: auto;
-	}
-
-	#footer ul
-	{
-		width: 25%;
-		display: table-cell;
-		padding-left: 2em;
-	}
-
-	#footer ul:first-child
-	{
-		padding-left: 0px;
-	}
-
-/*********************************************************************************/
-/* Featured                                                                      */
-/*********************************************************************************/
-	
-	#featured
-	{
-		padding: 3em 0em 1em 0em;
-	}
-	
-	#featured p
-	{
-		line-height: 1.5em;
-		font-size: 1.2em;
-	}
-	
-	.\31 u img { height:  6vw; }
-	.\32 u img { height: 12vw; }
-	.\33 u img { height: 18vw; }
-	.\34 u img { height: 24vw; }
-	.\36 u img { height: 36vw; }
-	.\37 u img { height: 42vw; }
-	.\38 u img { height: 48vw; }
-	.\39 u img { height: 54vw; }
-	.\31 0u img { height: 60vw; }
-	.\31 1u img { height: 66vw; }
-	.\31 2u img { height: 72vw; }
-	
-/*********************************************************************************/
-/* Horizontal menu                                                               */
-/*********************************************************************************/
-	.horiz-menu > ul
-	{
-		width: 100%;
-		margin: 0;
-		padding: 0;
-		display: table;
-		border-collapse: collapse;
-	}
-	.horiz-menu > ul > li
-	{
-		width: 25%;
-		border: 1px solid #000000;
-		display: table-cell;
-		color: #F03B11;
-	}
-	.horiz-menu > ul > li:hover
-	{
-		background: #FCECD4;
-		color: #802400;
-	}
-
-	.horiz-menu > ul > li > a
-	{
-		display: block;
-		padding: 1em;
-		border-bottom: 5px transparent;
-		white-space: nowrap;
-		color: inherit;
-	}
-	.horiz-menu > ul > li > a:hover
-	{
-		text-decoration: none;
-	}
-	.horiz-menu > ul > li.active > a
-	{
-		border-bottom: 5px #F03B11 solid;
-	}
-
-	.horiz-menu > ul > li.active > a:hover
-	{
-		border-bottom: 5px #802400 solid;
-	}
-
-	.horiz-menu > article
-	{
-		padding-top: 1em;
-		margin: 0;
-		display: none;
-	}
-
-	.horiz-menu > article.active
-	{
-		display: block;
-	}
-
-/*********************************************************************************/
-/* Nav                                                                           */
-/*********************************************************************************/
-
-	#titleBar
-	{
-		display: none !important;
-	}
-
-	#nav
-	{
-		display: block !important;
-		z-index: 2;
-		position: fixed;
-		background: #802400;
-		background: -webkit-linear-gradient(top, #802400 0%,#800800 100%);
-		background: linear-gradient(to bottom, #802400 0%,#800800 100%);
-		left: 0;
-		top: 0;
-		width: 100%;
-	}
-		
-		#nav > ul
-		{
-			text-align: right;
-			margin: 0;
-		}
-
-		#nav > ul > li
-		{
-			display: inline-block;
-			margin: 0;
-			padding: 0.5em 2em 0.5em 0em;
-			color: #FFF;
-			letter-spacing: 0.06em;
-			text-transform: uppercase;
-			font-size: 1.1em;
-		}
-
-		#nav a
-		{
-			text-decoration: none;
-			color: inherit;
-		}
-
-		#nav > ul > li > a,
-		#nav > ul > li > span
-		{
-			display: inline-block;
-			padding: 3px 0.5em 3px 0.5em;
-		}
-
-		#nav > ul > li:hover > a,
-		#nav > ul > li:hover > span
-		{
-			border-bottom: 3px solid #F0A833;
-			padding-bottom: 0px;
-		}
-
-		#nav li.current a
-		{
-			font-weight: 500;
-		}
-
-/*
-		#nav > ul > li.home
-		{
-			display: block;
-			float: left;
-		}
-*/
-
-		#nav > ul > li > ul
-		{
-			display: none;
-		}
-
-
-/* Colorbox customization */
-
-	body #cboxTitle { height: 50px; bottom: 24px; color: #000000; text-align: left; }
-	body #cboxMiddleLeft, body #cboxMiddleRight, body #cboxContent { padding-bottom: 50px; box-sizing: content-box; }
+	}
+
+	body,input,textarea,select
+	{
+	}
+
+	.homepage h1
+	{
+		font-size: 7em;
+		letter-spacing: -0.05em;
+	}
+
+	.homepage h2
+	{
+		font-size: 2.2em;
+	}
+
+	h1
+	{
+		font-size: 3em;
+	}
+
+	header
+	{
+		margin-bottom: 2em;
+	}
+	
+		header .byline
+		{
+			font-size: 1.7em;
+		}
+
+/*********************************************************************************/
+/* Header                                                                        */
+/*********************************************************************************/
+
+	#header
+	{
+		padding: 5em 0 2em 0;
+	}
+
+/*********************************************************************************/
+/* Main                                                                          */
+/*********************************************************************************/
+
+	#main,#sidebar {
+		margin-top: 5em;
+	}
+
+	#sidebar h1
+	{
+		font-size: 2.4em;
+		letter-spacing: 0em;
+		line-height: 1.2em;
+		margin-top: -0.2em;
+	}
+
+/*********************************************************************************/
+/* Footer                                                                        */
+/*********************************************************************************/
+	
+	#footer
+	{
+		padding: 1em 0em;
+	}
+	
+	#footer-inner
+	{
+		width: 95%;
+		display: table;
+		margin: auto;
+	}
+
+	#footer ul
+	{
+		width: 25%;
+		display: table-cell;
+		padding-left: 2em;
+	}
+
+	#footer ul:first-child
+	{
+		padding-left: 0px;
+	}
+
+/*********************************************************************************/
+/* Featured                                                                      */
+/*********************************************************************************/
+	
+	#featured
+	{
+		padding: 3em 0em 1em 0em;
+	}
+	
+	#featured p
+	{
+		line-height: 1.5em;
+		font-size: 1.2em;
+	}
+	
+	.\31 u img { height:  6vw; }
+	.\32 u img { height: 12vw; }
+	.\33 u img { height: 18vw; }
+	.\34 u img { height: 24vw; }
+	.\36 u img { height: 36vw; }
+	.\37 u img { height: 42vw; }
+	.\38 u img { height: 48vw; }
+	.\39 u img { height: 54vw; }
+	.\31 0u img { height: 60vw; }
+	.\31 1u img { height: 66vw; }
+	.\31 2u img { height: 72vw; }
+	
+/*********************************************************************************/
+/* Horizontal menu                                                               */
+/*********************************************************************************/
+	.horiz-menu > ul
+	{
+		width: 100%;
+		margin: 0;
+		padding: 0;
+		display: table;
+		border-collapse: collapse;
+	}
+	.horiz-menu > ul > li
+	{
+		width: 25%;
+		border: 1px solid #000000;
+		display: table-cell;
+		color: #F03B11;
+	}
+	.horiz-menu > ul > li:hover
+	{
+		background: #FCECD4;
+		color: #802400;
+	}
+
+	.horiz-menu > ul > li > a
+	{
+		display: block;
+		padding: 1em;
+		border-bottom: 5px transparent;
+		white-space: nowrap;
+		color: inherit;
+	}
+	.horiz-menu > ul > li > a:hover
+	{
+		text-decoration: none;
+	}
+	.horiz-menu > ul > li.active > a
+	{
+		border-bottom: 5px #F03B11 solid;
+	}
+
+	.horiz-menu > ul > li.active > a:hover
+	{
+		border-bottom: 5px #802400 solid;
+	}
+
+	.horiz-menu > article
+	{
+		padding-top: 1em;
+		margin: 0;
+		display: none;
+	}
+
+	.horiz-menu > article.active
+	{
+		display: block;
+	}
+
+/*********************************************************************************/
+/* Nav                                                                           */
+/*********************************************************************************/
+
+	#titleBar
+	{
+		display: none !important;
+	}
+
+	#nav
+	{
+		display: block !important;
+		z-index: 2;
+		position: fixed;
+		background: #802400;
+		background: -webkit-linear-gradient(top, #802400 0%,#800800 100%);
+		background: linear-gradient(to bottom, #802400 0%,#800800 100%);
+		left: 0;
+		top: 0;
+		width: 100%;
+	}
+		
+		#nav > ul
+		{
+			text-align: right;
+			margin: 0;
+		}
+
+		#nav > ul > li
+		{
+			display: inline-block;
+			margin: 0;
+			padding: 0.5em 2em 0.5em 0em;
+			color: #FFF;
+			letter-spacing: 0.06em;
+			text-transform: uppercase;
+			font-size: 1.1em;
+		}
+
+		#nav a
+		{
+			text-decoration: none;
+			color: inherit;
+		}
+
+		#nav > ul > li > a,
+		#nav > ul > li > span
+		{
+			display: inline-block;
+			padding: 3px 0.5em 3px 0.5em;
+		}
+
+		#nav > ul > li:hover > a,
+		#nav > ul > li:hover > span
+		{
+			border-bottom: 3px solid #F0A833;
+			padding-bottom: 0px;
+		}
+
+		#nav li.current a
+		{
+			font-weight: 500;
+		}
+
+/*
+		#nav > ul > li.home
+		{
+			display: block;
+			float: left;
+		}
+*/
+
+		#nav > ul > li > ul
+		{
+			display: none;
+		}
+
+
+/* Colorbox customization */
+
+	body #cboxTitle { height: 50px; bottom: 24px; color: #000000; text-align: left; }
+	body #cboxMiddleLeft, body #cboxMiddleRight, body #cboxContent { padding-bottom: 50px; box-sizing: content-box; }
assets/css/style-mobile.css +375 -375

750 lines not on this page · raw message

assets/css/style.css +592 -592

1,184 lines not on this page · raw message

index.html +89 -89

178 lines not on this page · raw message

Signature · 1 line
2.26.2
#3 lore raw

PATCH 3/7 make all links be relative to the root

In reply to Daniel P. Berrangé

This enables the site to be hosted at URLs with different base directories. This is useful when viewing the site after being published as GitLab CI artifacts.

---
 _includes/assets.html        | 28 ++++++++++++++--------------
 _includes/copyright.html     |  2 +-
 _includes/footer.html        | 12 ++++++------
 _includes/nav.html           | 12 ++++++------
 _includes/relative_root.html | 12 ++++++++++++
 _includes/sidebar.html       |  6 +++---
 _layouts/archive.html        |  4 ++--
 _layouts/blog.html           |  3 ++-
 _layouts/home.html           |  1 +
 _layouts/page.html           |  1 +
 blog/index.html              |  4 ++--
 index.html                   |  4 ++--
 12 files changed, 52 insertions(+), 37 deletions(-)
 create mode 100644 _includes/relative_root.html
_includes/assets.html +14 -14
index 826a50f..411a1ac 100644
@@ -4,23 +4,23 @@
 	<meta name="viewport" content="width=device-width">
 	<link href='https://fonts.googleapis.com/css?family=Roboto+Mono:300,400%7cRoboto:300,400,500' rel='stylesheet' type='text/css'>
 
-	<link rel="apple-touch-icon" sizes="180x180" href="/assets/favicons/apple-touch-icon.png">
-	<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicons/favicon-32x32.png">
-	<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicons/favicon-16x16.png">
-	<link rel="manifest" href="/assets/favicons/manifest.json">
-	<link rel="mask-icon" href="/assets/favicons/safari-pinned-tab.svg" color="#5bbad5">
-	<meta name="msapplication-config" content="/assets/favicons/browserconfig.xml">
+	<link rel="apple-touch-icon" sizes="180x180" href="{{ relative_root }}/assets/favicons/apple-touch-icon.png">
+	<link rel="icon" type="image/png" sizes="32x32" href="{{ relative_root }}/assets/favicons/favicon-32x32.png">
+	<link rel="icon" type="image/png" sizes="16x16" href="{{ relative_root }}/assets/favicons/favicon-16x16.png">
+	<link rel="manifest" href="{{ relative_root }}/assets/favicons/manifest.json">
+	<link rel="mask-icon" href="{{ relative_root }}/assets/favicons/safari-pinned-tab.svg" color="#5bbad5">
+	<meta name="msapplication-config" content="{{ relative_root }}/assets/favicons/browserconfig.xml">
 	<meta name="theme-color" content="#ffffff">
 
-	<link rel="stylesheet" href="/assets/css/normalize.css" />
+	<link rel="stylesheet" href="{{ relative_root }}/assets/css/normalize.css" />
 	<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" />
-	<link rel="stylesheet" href="/assets/css/skel-noscript.css" />
-	<link rel="stylesheet" href="/assets/css/style.css" />
-	<link rel="stylesheet" href="/assets/css/style-mobile.css" media="(max-width:699px)"/>
-	<link rel="stylesheet" href="/assets/css/style-desktop.css" media="(min-width:700px)" />
-	<link rel="alternate" title="QEMU Blog (Atom feed)" href="/feed.xml" type="application/atom+xml" />
+	<link rel="stylesheet" href="{{ relative_root }}/assets/css/skel-noscript.css" />
+	<link rel="stylesheet" href="{{ relative_root }}/assets/css/style.css" />
+	<link rel="stylesheet" href="{{ relative_root }}/assets/css/style-mobile.css" media="(max-width:699px)"/>
+	<link rel="stylesheet" href="{{ relative_root }}/assets/css/style-desktop.css" media="(min-width:700px)" />
+	<link rel="alternate" title="QEMU Blog (Atom feed)" href="{{ relative_root }}/feed.xml" type="application/atom+xml" />
 	<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
 	{% if page.colorbox %}
-	<script src="/assets/js/jquery.colorbox.js"></script>
-	<link rel="stylesheet" href="/assets/css/colorbox.css" />
+	<script src="{{ relative_root }}/assets/js/jquery.colorbox.js"></script>
+	<link rel="stylesheet" href="{{ relative_root }}/assets/css/colorbox.css" />
 	{% endif %}
_includes/copyright.html +1 -1
index 3e6e6a3..cdcd98f 100644
@@ -2,7 +2,7 @@
 	<div id="copyright-inner">
 	  <div class="container">
 	    This site is made available under the terms of
-	    <a href="/license.html">a number of licenses</a>.
+	    <a href="{{ relative_root }}/license.html">a number of licenses</a>.
 	  </div>
 	</div>
 </div>
_includes/footer.html +6 -6
index c8f1042..b614795 100644
@@ -1,20 +1,20 @@
 <div id="footer">
 	<div id="footer-inner">
 		<ul class="style">
-			<li><a href="/">Home</a></li>
-			<li><a href="/download">Download</a></li>
-			<li><a href="/conservancy/">Conservancy / Committee</a></li>
+			<li><a href="{{ relative_root }}/">Home</a></li>
+			<li><a href="{{ relative_root }}/download">Download</a></li>
+			<li><a href="{{ relative_root }}/conservancy/">Conservancy / Committee</a></li>
 			<li><a href="http://qemu-advent-calendar.org">QEMU advent calendar</a></li>
 		</ul>
 		<ul class="style">
-			<li><a href="/contribute">Contribute</a></li>
-			<li><a href="/contribute/report-a-bug">Reporting a bug</a></li>
+			<li><a href="{{ relative_root }}/contribute">Contribute</a></li>
+			<li><a href="{{ relative_root }}/contribute/report-a-bug">Reporting a bug</a></li>
 			<li><a href="https://wiki.qemu.org/Documentation/GettingStartedDevelopers">New contributors</a></li>
 			<li><a href="https://wiki.qemu.org/Contribute/SubmitAPatch">Submitting a patch</a></li>
 			<li><a href="https://wiki.qemu.org/Contribute/FAQ">Contributor FAQ</a></li>
 		</ul>
 		<ul class="style">
-			<li><a href="/documentation">Documentation</a></li>
+			<li><a href="{{ relative_root }}/documentation">Documentation</a></li>
 			<li><a href="https://www.qemu.org/docs/master/">Main docs</a></li>
 			<li><a href="https://wiki.qemu.org/Category:Developer_documentation">Developer docs</a></li>
 			<li><a href="https://wiki.qemu.org/">Wiki</a></li>
_includes/nav.html +6 -6
index 0c81e24..58b6c5a 100644
@@ -2,12 +2,12 @@
 	<nav id="nav">
 		<ul>
 			{% assign current = page.url | downcase | split: '/' %}
-			<li class='{% if page.url == '/' %}not-desktop {%endif %}home'><a href="/">Home</a>
-			</li><li {% if current[1] == 'download' %}class='current'{% endif %}><a href="/download">Download</a>
-			</li><li {% if current[1] == 'support' %}class='current'{% endif %}><a href="/support">Support</a>
-			</li><li {% if current[1] == 'contribute' %}class='current'{% endif %}><a href="/contribute">Contribute</a>
-			</li><li {% if current[1] == 'documentation' %}class='current'{% endif %}><a href="/documentation">Documentation</a>
-			</li><li {% if current[1] == 'blog' %}class='current'{% endif %}><a href="/blog">Blog</a></li>
+			<li class='{% if page.url == '/' %}not-desktop {%endif %}home'><a href="{{ relative_root }}/">Home</a>
+			</li><li {% if current[1] == 'download' %}class='current'{% endif %}><a href="{{ relative_root }}/download">Download</a>
+			</li><li {% if current[1] == 'support' %}class='current'{% endif %}><a href="{{ relative_root }}/support">Support</a>
+			</li><li {% if current[1] == 'contribute' %}class='current'{% endif %}><a href="{{ relative_root }}/contribute">Contribute</a>
+			</li><li {% if current[1] == 'documentation' %}class='current'{% endif %}><a href="{{ relative_root }}/documentation">Documentation</a>
+			</li><li {% if current[1] == 'blog' %}class='current'{% endif %}><a href="{{ relative_root }}/blog">Blog</a></li>
 		</ul>
 	</nav>
 
_includes/relative_root.html new file +12 -0
new file mode 100644
index 0000000..87c30e2
@@ -0,0 +1,12 @@
+{% assign relative_root = '' %}
+{% assign tempDepth = page.url | append: 'hackish-solution' | split: '/' | size | minus: 2 %}
+{% for i in (1..tempDepth) %}
+  {% if forloop.last %}
+    {% assign relative_root = relative_root | append: ".." %}
+  {% else %}
+    {% assign relative_root = relative_root | append: "../" %}
+  {% endif %}
+{% endfor %}
+{% if relative_root == '' %}
+    {% assign relative_root = '.' %}
+{% endif %}
_includes/sidebar.html +3 -3
index 0dc3538..f0cec2a 100644
@@ -9,7 +9,7 @@
 		<ul class="style">
 		{% for post in site.posts offset: 0 limit: 2 %}
 			<li>
-				<a href="{{ site.prefix }}{{ post.url }}">{{ post.title }}</a><br/>
+				<a href="{{ relative_root }}{{ post.url }}">{{ post.title }}</a><br/>
 				<span class="posted">{{ post.date | date_to_string }}</span>
 			</li>
 		{% endfor %}
@@ -31,12 +31,12 @@
 		{% assign thisurl = post.date | date: "%Y/%m" %}
 		{% assign thisdate = post.date | date: "%B %Y" %}
 		{% if thisurl != prevurl and prevurl != "" %}
-		<li><a href="/blog/{{ prevurl }}/">{{ prevdate }} ({{ counter }})</a></li>
+		<li><a href="{{ relative_root }}/blog/{{ prevurl }}/">{{ prevdate }} ({{ counter }})</a></li>
 		{% assign counter = 0 %}
 		{% endif %}
 		{% assign counter = counter | plus: 1 %}
 		{% endfor %}
-		<li><a href="/blog/{{ thisurl }}/">{{ thisdate }} ({{ counter }})</a></li>
+		<li><a href="{{ relative_root }}/blog/{{ thisurl }}/">{{ thisdate }} ({{ counter }})</a></li>
 		</ul>
 	</section>
 </div>
_layouts/archive.html +2 -2
index 4e67749..a0be7b8 100644
@@ -9,13 +9,13 @@ layout: blog
 		{% for post in page.posts %}
 		<article>
 			<header>
-				<h2><a href="{{ site.prefix }}{{ post.url }}">{{ post.title }}</a></h2>
+				<h2><a href="../../..{{ post.url }}">{{ post.title }}</a></h2>
 				<div class="posted">{{ post.date | date_to_string }}{%
 				if post.last_modified_at %} (Updated {{ post.last_modified_at | date_to_string }}) {%
 				endif %}{% if post.author %} &mdash; by {{ post.author }}{% endif %}</div>
 			</header>
 		{{ post.excerpt }}
-		<a href="{{ site.prefix }}{{ post.url }}" class="button button-style1">Read More</a>
+		<a href="../../..{{ post.url }}" class="button button-style1">Read More</a>
 		</article>
 		{% endfor %}
 	</section>
_layouts/blog.html +2 -1
index 2dfb9c8..b300636 100644
@@ -3,7 +3,8 @@
 Linear by TEMPLATED
 templated.co @templatedco
 Released for free under the Creative Commons Attribution 3.0 license (templated.co/license)
--->
+  -->
+{% include relative_root.html %}
 <html>
 <head>
 	<title>{{ page.title }} - {{ site.title }}</title>
_layouts/home.html +1 -0
index b96e391..d94c9b0 100644
@@ -4,6 +4,7 @@ Linear by TEMPLATED
 templated.co @templatedco
 Released for free under the Creative Commons Attribution 3.0 license (templated.co/license)
 -->
+{% include relative_root.html %}
 <html>
 <head>
 	<title>{{ site.title }}</title>
_layouts/page.html +1 -0
index 110ca97..d650054 100644
@@ -4,6 +4,7 @@ Linear by TEMPLATED
 templated.co @templatedco
 Released for free under the Creative Commons Attribution 3.0 license (templated.co/license)
 -->
+{% include relative_root.html %}
 <html>
 <head>
 	<title>{{ page.title }} - {{ site.title }}</title>
blog/index.html +2 -2
index 313b994..c7ceb0a 100644
@@ -8,7 +8,7 @@ layout: blog
 	<div class="row">
 		<section>
 			<header>
-				<h1><a href="{{ site.prefix }}{{ post.url }}">{{ post.title }}</a></h1>
+				<h1><a href="{{ relative_root }}{{ post.url }}">{{ post.title }}</a></h1>
 				<div class="posted">{{ post.date | date_to_string }}{%
 				if post.last_modified_at %} (Updated {{ post.last_modified_at | date_to_string }}) {%
 				endif %}{% if post.author %} &mdash; by {{ post.author }}{% endif %}</div>
@@ -22,7 +22,7 @@ layout: blog
 				</ul>
 			{% else %}
 				{{ post.excerpt }}
-				<a href="{{ site.prefix }}{{ post.url }}" class="button button-style1">Read More</a>
+				<a href="{{ relative_root }}{{ post.url }}" class="button button-style1">Read More</a>
 			{% endif %}
 		</section>
 	</div>
index.html +2 -2
index 4c65101..ca2f7e9 100644
@@ -38,7 +38,7 @@ colorbox: True
 			{% include screenshot.html offset=3 limit=10 %}
 			</section>
 
-<script src="/assets/js/object-fit.js"></script>
+<script src="{{ relative_root }}/assets/js/object-fit.js"></script>
 <script>
 window.hasColorBox = false;
 $(window).on("load resize", function() {
@@ -62,7 +62,7 @@ $('.colorbox').on("click.random-namespace", function() {
 
 		</div>
 		<hr>
-		<p>QEMU is a member of <a href="/conservancy/">Software Freedom Conservancy</a>.</p>
+		<p>QEMU is a member of <a href="{{ relative_root }}/conservancy/">Software Freedom Conservancy</a>.</p>
 	</div>
 </div>
 
Signature · 1 line
2.26.2
#4 lore raw

PATCH 4/7 Make page header nav narrower

In reply to Daniel P. Berrangé

When the browser window is narrow, but not yet switched into the mobile layout, the page header nav will line wrap. This breaks layout assumptions resulting in overlapping/obscured text.

This deals with the probem by reducing padding between the links, and shortening "Documentation" to just "Docs".

This avoids the line wrapping, as well as making room for new links in the future.

---
 _includes/nav.html           | 2 +-
 assets/css/style-desktop.css | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)
_includes/nav.html +1 -1
index 58b6c5a..c66ee92 100644
@@ -6,7 +6,7 @@
 			</li><li {% if current[1] == 'download' %}class='current'{% endif %}><a href="{{ relative_root }}/download">Download</a>
 			</li><li {% if current[1] == 'support' %}class='current'{% endif %}><a href="{{ relative_root }}/support">Support</a>
 			</li><li {% if current[1] == 'contribute' %}class='current'{% endif %}><a href="{{ relative_root }}/contribute">Contribute</a>
-			</li><li {% if current[1] == 'documentation' %}class='current'{% endif %}><a href="{{ relative_root }}/documentation">Documentation</a>
+			</li><li {% if current[1] == 'documentation' %}class='current'{% endif %}><a href="{{ relative_root }}/documentation">Docs</a>
 			</li><li {% if current[1] == 'blog' %}class='current'{% endif %}><a href="{{ relative_root }}/blog">Blog</a></li>
 		</ul>
 	</nav>
assets/css/style-desktop.css +2 -1
index ce58fe2..b7e403a 100644
@@ -237,13 +237,14 @@
 		{
 			text-align: right;
 			margin: 0;
+			padding: 0;
 		}
 
 		#nav > ul > li
 		{
 			display: inline-block;
 			margin: 0;
-			padding: 0.5em 2em 0.5em 0em;
+			padding: 0.5em 1em 0.5em 0em;
 			color: #FFF;
 			letter-spacing: 0.06em;
 			text-transform: uppercase;
Signature · 1 line
2.26.2
#0 lore raw

cover Tweaks to page footer and add "edit page" links

This series started off as a desire to add an "Edit page" link to every page on the site. In doing this I felt that the footer would benefit from simplication so that it was not a massive wall of links, duplicating links elsewhere in the navigation or content pages.

I also add gitlab CI jobs so that users can push a branch to gitlab and then browse the rendered result.

eg see this pipeline:

https://gitlab.com/berrange/qemu-web/-/pipelines/206891542

and the rendered result:

https://berrange.gitlab.io/qemu-web/

Or browsable at

https://gitlab.com/berrange/qemu-web/-/jobs/809000762/artifacts/browse/publ=
ic/

Or download ZIP at

https://gitlab.com/berrange/qemu-web/-/jobs/809000762/artifacts/download

notice how the resulting content needs to cope with being used from a variety of different paths. IOW, we cannot use absolute hyperlinks that assume the root is "/". Jekyll doesn't make this easy, so we use a hack with a custom template that sets a variable we can then reference.

The logical next step for this would be to accept merge requests, so that once the user saves their edits in gitlab, they can directly submit a MR, instead of sending via email. I noticed we don't currently have a CONTRIBUTING.md file in qemu-web.git telling people how to submit. So this series includes such a file directing people to send patches via email for now.

Daniel P. Berrang=C3=A9 (7):
Convert files to UNIX line endings
gitlab: introduce a CI job to publish the site content make all links be relative to the root
Make page header nav narrower
Simplify and restructure the page footer
Add link to "edit this page" for all pages
Add a CONTRIBUTING.md file as guidance for contributors

 .gitlab-ci.yml               |   16 +
 CONTRIBUTING.md              |   32 +
 _config.yml                  |    1 +
 _includes/assets.html        |   28 +-
 _includes/copyright.html     |    8 -
 _includes/footer.html        |   33 +-
 _includes/nav.html           |   13 +-
 _includes/relative_root.html |   12 +
 _includes/sidebar.html       |    6 +-
 _layouts/archive.html        |    4 +-
 _layouts/blog.html           |    4 +-
 _layouts/home.html           |    2 +-
 _layouts/page.html           |    2 +-
 assets/css/style-desktop.css |  575 ++++++++--------
 assets/css/style-mobile.css  |  739 +++++++++++----------
 assets/css/style.css         | 1200 +++++++++++++++++-----------------
 blog/index.html              |    4 +-
 index.html                   |  178 ++---
 18 files changed, 1448 insertions(+), 1409 deletions(-)
 create mode 100644 .gitlab-ci.yml
 create mode 100644 CONTRIBUTING.md
 delete mode 100644 _includes/copyright.html
 create mode 100644 _includes/relative_root.html

--=20
2.26.2

#5 lore raw

PATCH 5/7 Simplify and restructure the page footer

The page footer currently has a large wall of links.

Many of the links duplicate what is already present in the page header navbar. The header is styled to have a fixed position, it will always be on screen. The footer meanwhile is often off the bottom of the screen.

Other links from the footer are already present in the 'contribute' and 'documentation' pages, with more descriptive text.

The wiki link would be better placed in the top header where it is more obviously visible to users.

With this change the footer is slimmed down to avoid link duplication, leaving it primarily focused on providing links to the related external sites.

The wiki link is moved to the header nav which has extra space after the previous patch.

Finally the conservancy link pulled out and placed just below the footer adjacent to the licensing link, giving it more prominence.

---
 _includes/copyright.html     |  8 --------
 _includes/footer.html        | 30 +++++++++---------------------
 _includes/nav.html           |  1 +
 _layouts/blog.html           |  1 -
 _layouts/home.html           |  1 -
 _layouts/page.html           |  1 -
 assets/css/style-desktop.css | 24 ++++--------------------
 assets/css/style-mobile.css  | 13 +------------
 assets/css/style.css         | 36 ++++++++++++++++++++++++++----------
 9 files changed, 41 insertions(+), 74 deletions(-)
 delete mode 100644 _includes/copyright.html
_includes/copyright.html deleted +0 -8
deleted file mode 100644
index cdcd98f..0000000
@@ -1,8 +0,0 @@
-<div id="copyright">
-	<div id="copyright-inner">
-	  <div class="container">
-	    This site is made available under the terms of
-	    <a href="{{ relative_root }}/license.html">a number of licenses</a>.
-	  </div>
-	</div>
-</div>
_includes/footer.html +9 -21
index b614795..2dd247b 100644
@@ -1,30 +1,18 @@
 <div id="footer">
-	<div id="footer-inner">
+	<div id="external-links">
 		<ul class="style">
-			<li><a href="{{ relative_root }}/">Home</a></li>
-			<li><a href="{{ relative_root }}/download">Download</a></li>
-			<li><a href="{{ relative_root }}/conservancy/">Conservancy / Committee</a></li>
-			<li><a href="http://qemu-advent-calendar.org">QEMU advent calendar</a></li>
-		</ul>
-		<ul class="style">
-			<li><a href="{{ relative_root }}/contribute">Contribute</a></li>
-			<li><a href="{{ relative_root }}/contribute/report-a-bug">Reporting a bug</a></li>
-			<li><a href="https://wiki.qemu.org/Documentation/GettingStartedDevelopers">New contributors</a></li>
-			<li><a href="https://wiki.qemu.org/Contribute/SubmitAPatch">Submitting a patch</a></li>
-			<li><a href="https://wiki.qemu.org/Contribute/FAQ">Contributor FAQ</a></li>
-		</ul>
-		<ul class="style">
-			<li><a href="{{ relative_root }}/documentation">Documentation</a></li>
-			<li><a href="https://www.qemu.org/docs/master/">Main docs</a></li>
-			<li><a href="https://wiki.qemu.org/Category:Developer_documentation">Developer docs</a></li>
-			<li><a href="https://wiki.qemu.org/">Wiki</a></li>
-		</ul>
-		<ul class="style">
-			<li><a href="https://planet.virt-tools.org/">virt tools planet</a></li>
+			<li><a href="http://qemu-advent-calendar.org">Advent calendar</a></li>
+			<li><a href="https://planet.virt-tools.org/">Blog planet</a></li>
 			<li><a href="https://www.linux-kvm.org/">KVM</a></li>
 			<li><a href="http://libguestfs.org/">Libguestfs</a></li>
 			<li><a href="https://libvirt.org/">Libvirt</a></li>
 			<li><a href="https://xenproject.org">Xen</a></li>
 		</ul>
 	</div>
+	<div id="conservancy">
+	  QEMU is a member of <a href="{{ relative_root }}/conservancy/">Software Freedom Conservancy</a>
+	</div>
+	<div id="licenses">
+	  <a href="{{ relative_root }}/license.html">Website licenses</a>
+	</div>
 </div>
_includes/nav.html +1 -0
index c66ee92..73b39b3 100644
@@ -7,6 +7,7 @@
 			</li><li {% if current[1] == 'support' %}class='current'{% endif %}><a href="{{ relative_root }}/support">Support</a>
 			</li><li {% if current[1] == 'contribute' %}class='current'{% endif %}><a href="{{ relative_root }}/contribute">Contribute</a>
 			</li><li {% if current[1] == 'documentation' %}class='current'{% endif %}><a href="{{ relative_root }}/documentation">Docs</a>
+			</li><li><a href="https://wiki.qemu.org">Wiki</a>
 			</li><li {% if current[1] == 'blog' %}class='current'{% endif %}><a href="{{ relative_root }}/blog">Blog</a></li>
 		</ul>
 	</nav>
_layouts/blog.html +0 -1
index b300636..b7fcdbf 100644
@@ -21,7 +21,6 @@ Released for free under the Creative Commons Attribution 3.0 license (templated.
 	
 	{% include sidebar.html %}
 	{% include footer.html %}
-	{% include copyright.html %}
 
 </body>
 </html>
_layouts/home.html +0 -1
index d94c9b0..f7b6931 100644
@@ -18,7 +18,6 @@ Released for free under the Creative Commons Attribution 3.0 license (templated.
 	{{ content }}
 
 	{% include footer.html %}
-	{% include copyright.html %}
 
 </body>
 </html>
_layouts/page.html +0 -1
index d650054..765d204 100644
@@ -23,7 +23,6 @@ Released for free under the Creative Commons Attribution 3.0 license (templated.
 	</div>
 	
 	{% include footer.html %}
-	{% include copyright.html %}
 
 </body>
 </html>
assets/css/style-desktop.css +4 -20
index b7e403a..d45ec15 100644
@@ -101,29 +101,13 @@
 /*********************************************************************************/
 /* Footer                                                                        */
 /*********************************************************************************/
-	
-	#footer
-	{
-		padding: 1em 0em;
-	}
-	
-	#footer-inner
-	{
-		width: 95%;
-		display: table;
-		margin: auto;
-	}
 
-	#footer ul
-	{
-		width: 25%;
-		display: table-cell;
-		padding-left: 2em;
+	#licenses {
+		float: right;
 	}
 
-	#footer ul:first-child
-	{
-		padding-left: 0px;
+	#conservancy {
+		float: left;
 	}
 
 /*********************************************************************************/
assets/css/style-mobile.css +1 -12
index 8910e71..652650b 100644
@@ -242,7 +242,7 @@
 /* Columns                                                                       */
 /*********************************************************************************/
 
-	#main, #footer-inner, #copyright-inner
+	#main, #copyright-inner
 	{
 		margin-left: 0%;
 		width: 100%;
@@ -283,19 +283,8 @@
 	
 	#footer
 	{
-		padding: 1em;
-	}
-	
-	#footer ul
-	{
-		padding: 0.6em 0px;
-		border-top: 1px solid white;
 	}
 
-	#footer ul:first-child
-	{
-		border-top: 0px;
-	}
 	
 /*********************************************************************************/
 /* Featured                                                                      */
assets/css/style.css +26 -10
index e09b383..e2fee29 100644
@@ -503,24 +503,40 @@
 	{
 		position: relative;
 		clear: left;
-		background: #401200;
-		color: #FFF;
 	}
 	
 	#footer a
 	{
 		color: inherit;
 	}
-	
-	#footer ul
-	{
-		vertical-align: top;
+
+	#footer ul {
+		margin: 0em;
 	}
 
-	#footer ul, #footer ul > li
-	{
-		padding: 0;
-		margin: 0
+	#conservancy, #licenses {
+		padding: 0em;
+		padding-left: 1em;
+		padding-right: 1em;
+		font-size: smaller;
+		color: #707070;
+		margin: 0em;
+	}
+
+	#external-links {
+		padding: 0em;
+		padding-top: 0.3em;
+		padding-bottom: 0.3em;
+		background: #401200;
+		color: #FFF;
+		text-align: center;
+	}
+
+	#external-links li {
+		display: inline;
+	}
+	#external-links li a {
+		padding-left: 1em;
 	}
 
 /*********************************************************************************/
Signature · 1 line
2.26.2
#10 lore raw

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

In reply to Daniel P. Berrangé
Quoted 7 lines · Daniel P. Berrangé

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.

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

Quoted 47 lines
---
 _includes/footer.html        | 3 +++
 assets/css/style-desktop.css | 4 ++++
 assets/css/style.css         | 2 +-
 3 files changed, 8 insertions(+), 1 deletion(-)
_includes/footer.html +3 -0
index 2dd247b..0a77d8e 100644
@@ -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>
assets/css/style-desktop.css +4 -0
index d45ec15..19272ad 100644
@@ -102,6 +102,10 @@
 /* Footer                                                                        */
 /*********************************************************************************/
 
+	#edit-page {
+		text-align: right;
+	}
+
 	#licenses {
 		float: right;
 	}
assets/css/style.css +1 -1
index e2fee29..50bbcd1 100644
@@ -514,7 +514,7 @@
 		margin: 0em;
 	}
 
-	#conservancy, #licenses {
+	#conservancy, #licenses, #edit-page {
 		padding: 0em;
 		padding-left: 1em;
 		padding-right: 1em;
#9 lore raw

PATCH 6/7 Add link to "edit this page" for all pages

In reply to Daniel P. Berrangé

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.

---
 _includes/footer.html        | 3 +++
 assets/css/style-desktop.css | 4 ++++
 assets/css/style.css         | 2 +-
 3 files changed, 8 insertions(+), 1 deletion(-)
_includes/footer.html +3 -0
index 2dd247b..0a77d8e 100644
@@ -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>
assets/css/style-desktop.css +4 -0
index d45ec15..19272ad 100644
@@ -102,6 +102,10 @@
 /* Footer                                                                        */
 /*********************************************************************************/
 
+	#edit-page {
+		text-align: right;
+	}
+
 	#licenses {
 		float: right;
 	}
assets/css/style.css +1 -1
index e2fee29..50bbcd1 100644
@@ -514,7 +514,7 @@
 		margin: 0em;
 	}
 
-	#conservancy, #licenses {
+	#conservancy, #licenses, #edit-page {
 		padding: 0em;
 		padding-left: 1em;
 		padding-right: 1em;
Signature · 1 line
2.26.2
#6 lore raw

Re: [qemu-web PATCH 5/7] Simplify and restructure the page footer

In reply to Daniel P. Berrangé
Quoted 4 lines · Daniel P. Berrangé
_includes/footer.html +1 -2
+	<div id="external-links">
 		<ul class="style">
-			<li><a href="{{ relative_root }}/">Home</a></li>
-			<li><a href="{{ relative_root }}/download">Download</a></li>

_includes/footer.html line 15

Quoted 10 lines
_includes/footer.html +0 -10
-			<li><a href="{{ relative_root }}/conservancy/">Conservancy / Committee</a></li>
-			<li><a href="http://qemu-advent-calendar.org">QEMU advent calendar</a></li>
-		</ul>
-		<ul class="style">
-			<li><a href="{{ relative_root }}/contribute">Contribute</a></li>
-			<li><a href="{{ relative_root }}/contribute/report-a-bug">Reporting a bug</a></li>
-			<li><a href="https://wiki.qemu.org/Documentation/GettingStartedDevelopers">New contributors</a></li>
-			<li><a href="https://wiki.qemu.org/Contribute/SubmitAPatch">Submitting a patch</a></li>
-			<li><a href="https://wiki.qemu.org/Contribute/FAQ">Contributor FAQ</a></li>
-		</ul>

I would rather keep this column, the idea is that this information can be found with a quick Ctrl-F "bug" or "Ctrl-F "faq".

Otherwise I agree it's an improvement.

Paolo

Quoted 10 lines
_includes/footer.html +2 -8
-		<ul class="style">
-			<li><a href="{{ relative_root }}/documentation">Documentation</a></li>
-			<li><a href="https://www.qemu.org/docs/master/">Main docs</a></li>
-			<li><a href="https://wiki.qemu.org/Category:Developer_documentation">Developer docs</a></li>
-			<li><a href="https://wiki.qemu.org/">Wiki</a></li>
-		</ul>
-		<ul class="style">
-			<li><a href="https://planet.virt-tools.org/">virt tools planet</a></li>
+			<li><a href="http://qemu-advent-calendar.org">Advent calendar</a></li>
+			<li><a href="https://planet.virt-tools.org/">Blog planet</a></li>
#14 lore raw

Re: [qemu-web PATCH 7/7] Add a CONTRIBUTING.md file as guidance for contributors

In reply to Daniel P. Berrangé
Quoted 22 lines · Daniel P. Berrangé
---
 CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++
 _config.yml     |  1 +
 2 files changed, 33 insertions(+)
 create mode 100644 CONTRIBUTING.md
CONTRIBUTING.md new file +9 -0
new file mode 100644
index 0000000..0be58d8
@@ -0,0 +1,32 @@
+# Contributing to qemu-web
+
+The QEMU project accepts code contributions to the website as patches sent to
+the the developer mailing list:
+
+https://lists.nongnu.org/mailman/listinfo/qemu-devel
+
+For further guidance on sending patches consult:
+

CONTRIBUTING.md line 19

Quoted 10 lines
CONTRIBUTING.md new file +10 -0
+https://wiki.qemu.org/Contribute/SubmitAPatch
+
+It is expected that contributors check the rendered website before submitting
+patches. This is possible by either running jekyll locally, or by using the
+GitLab CI and Pages infrastructure.
+
+Any branch that is pushed to a GitLab fork will result in a CI job being run
+visible at
+
+https://gitlab.com/yourusername/libvirt-perl/pipelines

Apart from the pasto, I think it is
https://gitlab.com/yourusername/qemu-web/-/pipelines.

CONTRIBUTING.md line 23

Quoted 3 lines
CONTRIBUTING.md new file +3 -0
+The rendered result can be then viewed at
+
+https://yourusername.gitlab.io/qemu-web

Very cool, thanks.

Paolo

Quoted 18 lines
CONTRIBUTING.md new file +8 -0
+Contributions submitted to the project must be in compliance with the
+Developer Certificate of Origin Version 1.1. This is documented at:
+
+https://developercertificate.org/
+
+To indicate compliance, each commit in a series must have a "Signed-off-by"
+tag with the submitter's name and email address. This can be added by passing
+the ``-s`` flag to ``git commit`` when creating the patches.
_config.yml +1 -0
index d0473c1..7d34779 100644
@@ -40,3 +40,4 @@ exclude:
   - Gemfile.lock
   - vendor/
   - README
+  - CONTRIBUTING.md
#7 lore raw

Re: [qemu-web PATCH 5/7] Simplify and restructure the page footer

In reply to Paolo Bonzini
Quoted 10 lines · Paolo Bonzini
Quoted 9 lines · Daniel P. Berrangé
_includes/footer.html +1 -7
+	<div id="external-links">
 		<ul class="style">
-			<li><a href="{{ relative_root }}/">Home</a></li>
-			<li><a href="{{ relative_root }}/download">Download</a></li>
-			<li><a href="{{ relative_root }}/conservancy/">Conservancy / Committee</a></li>
-			<li><a href="http://qemu-advent-calendar.org">QEMU advent calendar</a></li>
-		</ul>
-		<ul class="style">
-			<li><a href="{{ relative_root }}/contribute">Contribute</a></li>
Quoted 8 lines

_includes/footer.html line 15

Quoted 5 lines
_includes/footer.html +0 -5
-			<li><a href="{{ relative_root }}/contribute/report-a-bug">Reporting a bug</a></li>
-			<li><a href="https://wiki.qemu.org/Documentation/GettingStartedDevelopers">New contributors</a></li>
-			<li><a href="https://wiki.qemu.org/Contribute/SubmitAPatch">Submitting a patch</a></li>
-			<li><a href="https://wiki.qemu.org/Contribute/FAQ">Contributor FAQ</a></li>
-		</ul>

I would rather keep this column, the idea is that this information can be found with a quick Ctrl-F "bug" or "Ctrl-F "faq".

If there are useful links that are hidden such that people have to use "Ctrl-f <term>" to search for them, then I think we've failed at design already.

I'm inclined to do some work on the top level index page to make these things be prominent links you can see without scrolling or searching when hitting the http://qemu.org/ front page.

IMHO the front page has way too much real estate taken up with the screenshots and big headings, and very little useful content right now. On my laptop 50% of the vertical space is the top header nav bar, the huge "QEMU" heading and then the subheading. The other 50% of vertical space is the screenshots. The most interesting content on the front page is the summary of latest releases, but that's off screen. I'll have a play with tweaking the layout to improve this.

Regards,
Daniel

Signature · 3 lines
|: 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 :|
#12 lore raw

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

In reply to Daniel P. Berrangé
Quoted 7 lines · Daniel P. Berrangé
Quoted 2 lines

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

#11 lore raw

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

In reply to Paolo Bonzini
Quoted 11 lines · Paolo Bonzini
Quoted 7 lines · Daniel P. Berrangé

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.

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.

Quoted 44 lines

Paolo

Quoted 41 lines
---
 _includes/footer.html        | 3 +++
 assets/css/style-desktop.css | 4 ++++
 assets/css/style.css         | 2 +-
 3 files changed, 8 insertions(+), 1 deletion(-)
_includes/footer.html +3 -0
index 2dd247b..0a77d8e 100644
@@ -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>
assets/css/style-desktop.css +4 -0
index d45ec15..19272ad 100644
@@ -102,6 +102,10 @@
 /* Footer                                                                        */
 /*********************************************************************************/
 
+	#edit-page {
+		text-align: right;
+	}
+
 	#licenses {
 		float: right;
 	}
assets/css/style.css +0 -0
index e2fee29..50bbcd1 100644
@@ -514,7 +514,7 @@
 		margin: 0em;
 	}
 
Quoted 8 lines

assets/css/style.css line 520

Quoted 6 lines
assets/css/style.css +1 -1
-	#conservancy, #licenses {
+	#conservancy, #licenses, #edit-page {
 		padding: 0em;
 		padding-left: 1em;
 		padding-right: 1em;

Regards,
Daniel

Signature · 3 lines
|: 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 :|
#8 lore raw

Re: [qemu-web PATCH 5/7] Simplify and restructure the page footer

In reply to Daniel P. Berrangé
Quoted 6 lines · Daniel P. Berrangé
Quoted 2 lines

I would rather keep this column, the idea is that this information can be found with a quick Ctrl-F "bug" or "Ctrl-F "faq".

If there are useful links that are hidden such that people have to use "Ctrl-f <term>" to search for them, then I think we've failed at design already.

As you said the links are already mostly available from the "contribute" page. "Report a bug" is a bit of an in-the-middle case that is niche enough that it should not be too prominent, but still worth being available in the home page in some way.

Quoted 3 lines

IMHO the front page has way too much real estate taken up with the screenshots and big headings, and very little useful content right now.

Yeah, that's true (that is something that was inherited from template I used, which you can see for reference at https://templated.co/linear).

Paolo