[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#807954: debian-live: setup automated builds of live-manual

> Package: debian-live
> Severity: normal
> 
> Hi,
> 
> The old server providing live.debian.net has been shutdown. The hosted
> versions of the live-manual package should now be located on the
> debian-live group's Alioth webspace instead now.

Is there still interest to get the live-manual built on official Debian
machines / included on the Debian website?

In this case, I would vote for using the same mechanism as currently used
for all the other documents under www.debian.org/doc.
That is: the documents are not being built in particular for the debian website;
instead, their respective binary packages from unstable are unpacked, relevant 
files (mostly .html or .pdf) are copied to the correct directory, sometimes
renamed, and that's it.

To get a manual updated on the Debian website, one just needs to upload a
new version to unstable, and the rest is done auto-magic-ally :-)



To make this happen, changes for two git repos are needed:
https://salsa.debian.org/webmaster-team/cron
and
https://salsa.debian.org/webmaster-team/webwml


I have prepared (and tested) patches for both; attached.

That would add the 'all-in-one-html-file' variant of live-manual to
https://www.debian.org/doc/devel-manuals

I have also added a built of the devel-manuals html page, to give an idea,
how it might look like.


Regards

Holger




-- 
Holger Wansing <hwansing@mailbox.org>
PGP-Fingerprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076

diff --git a/parts/1ftpfiles b/parts/1ftpfiles
index bb8bdb0..8d38dce 100755
--- a/parts/1ftpfiles
+++ b/parts/1ftpfiles
@@ -94,6 +94,7 @@ getdeb all debian-refcard
 getdeb amd64 build-essential
 getdeb amd64 menu
 getdeb amd64 python3-dev
+getdeb amd64 live-manual-html
 
 # Files in $crondir/ftpfiles/doc are not used any more ???
 # This should make clear if someone tries and fails.
diff --git a/parts/7doc b/parts/7doc
index 9d7421f..c2c742d 100755
--- a/parts/7doc
+++ b/parts/7doc
@@ -620,6 +620,18 @@ for lang in $langlist ; do
 done
 fi
 
+unpack live-manual-html
+if [ ! -e $ftpdir/${dist}/live-manual-html.skip ]; then
+langlist=`file2lang live-manual .html usr/share/doc/live-manual/html`
+for lang in $langlist ; do
+	mvhtml live-manual/html usr/share/doc/live-manual/html YES $lang
+	mv $webdocdir/manuals/live-manual/html/live-manual.$lang.html $webdocdir/manuals/live-manual/html/index.$lang.html
+done
+mv usr/share/doc/live-manual/_sisu $webdocdir/manuals/live-manual/_sisu
+fi
+
+
+
 # Move broken code segment here for debug
 #echo
 #echo "7doc start debug (at `date`)"

diff --git a/english/doc/devel-manuals.defs b/english/doc/devel-manuals.defs
index 4a789a21abc..7bc102528fb 100644
--- a/english/doc/devel-manuals.defs
+++ b/english/doc/devel-manuals.defs
@@ -83,3 +83,14 @@
             vcsrepo="https://salsa.debian.org/debian/dbconfig-common.git";
             />
 </define-tag>
+
+<define-tag inddpvcs-live-manual whitespace=delete>
+  <inddpvcs name="live-manual/html"
+            langs="en ca de es fr it ja pl pt_BR ro"
+            formats="html"
+            srctype="XML"
+            vcstype="git"
+            vcsweb="https://salsa.debian.org/live-team/live-manual";
+            vcsrepo="https://salsa.debian.org/live-team/live-manual.git";
+            />
+</define-tag>
diff --git a/english/doc/devel-manuals.wml b/english/doc/devel-manuals.wml
index ac0923d903e..1d113c81caf 100644
--- a/english/doc/devel-manuals.wml
+++ b/english/doc/devel-manuals.wml
@@ -260,3 +260,29 @@ package, and packaging the <code>gnujump</code> game and a Java library.
 </doctable>
 </div>
 
+<hr>
+
+<document "Debian Live Manual" "live-manual">
+
+<div class="centerblock">
+<p>
+  This document describes the build of Debian live images.
+
+  <p>FIXME:
+     debian-live team: please add some useful short description here!
+     FIXME
+  </p>
+
+<doctable>
+  <authors "Debian Live Team">
+  <maintainer "Debian Live Team">
+  <status>
+  ready
+  </status>
+  <availability>
+  <inpackage "live-manual">
+  <inddpvcs-live-manual>
+  </availability>
+</doctable>
+</div>
+
diff --git a/english/doc/index.wml b/english/doc/index.wml
index c98072d6de9..dad274a9b0d 100644
--- a/english/doc/index.wml
+++ b/english/doc/index.wml
@@ -104,6 +104,7 @@ name and/or links to the online versions.</p>
       <li><a href="devel-manuals#d-i-internals">Debian Installer internals</a></li>
       <li><a href="devel-manuals#dbconfig-common">Guide for database using package maintainers</a></li>
       <li><a href="devel-manuals#dbapp-policy">Policy for packages using databases</a></li>
+      <li><a href="devel-manuals#live-manual">Debian Live manual</a></li>
     </ul>
 
   </div>
Title: Debian -- Debian Developers' Manuals

Debian Developers' Manuals

Debian Policy Manual

This manual describes the policy requirements for the Debian GNU/Linux distribution. This includes the structure and contents of the Debian archive, several design issues of the operating system, as well as technical requirements that each package must satisfy to be included in the distribution.

Authors: Ian Jackson, Christian Schwarz, David A. Morris
Maintainer: The Debian Policy group
Status: ready
Availability: Debian package debian-policy
Latest version:

The latest restructuredText source is available through the Git repository.

Proposed amendments to Policy

Supplemental Policy documentation:

Debian Developer's Reference

This manual describes procedures and resources for Debian maintainers. It describes how to become a new developer, the upload procedure, how to handle our bug tracking system, the mailing lists, Internet servers, etc.

This manual is thought as a reference manual for all Debian developers (newbies and old pros).

Authors: Ian Jackson, Christian Schwarz, Lucas Nussbaum, Raphaël Hertzog, Adam Di Carlo, Andreas Barth
Maintainer: Lucas Nussbaum, Hideki Yamane, Holger Levsen
Status: ready
Availability: Debian package developers-reference
Latest version:

The latest restructuredText source is available through the Git repository.

Guide for Debian Maintainers

This tutorial document describes the building of the Debian package to ordinary Debian users and prospective developers using the debmake command.

It is focused on the modern packaging style and comes with many simple examples.

This “Guide for Debian Maintainers” can be considered as the successor to the “Debian New Maintainers’ Guide”.

Authors: Osamu Aoki
Maintainer: Osamu Aoki
Status: ready
Availability: Debian package debmake-doc
Latest version:

The latest XML source is available through the Git repository.

Debian New Maintainers' Guide

This document will try to describe building of a Debian GNU/Linux package to the common Debian user (and wannabe developer) in common language, and well covered with working examples.

Unlike previous attempts, this one is based on debhelper and the new tools available to maintainers. The author is making every attempt to incorporate and unify previous efforts.

Authors: Josip Rodin, Osamu Aoki
Maintainer: Osamu Aoki
Status: outdated, use above “Guide for Debian Maintainers” (debmake-doc)
Availability: Debian package maint-guide
Latest version:

The latest XML source is available through the Git repository.

Introduction to Debian packaging

This tutorial is an introduction to Debian packaging. It teaches prospective developers how to modify existing packages, how to create their own packages, and how to interact with the Debian community. In addition to the main tutorial, it includes three practical sessions on modifying the grep package, and packaging the gnujump game and a Java library.

Authors: Lucas Nussbaum
Maintainer: Lucas Nussbaum
Status: ready
Availability: Debian package packaging-tutorial
Latest version:
  • English: [PDF]
  • German: [PDF]
  • Spanish: [PDF]
  • French: [PDF]
  • Japanese: [PDF]
  • Portuguese: [PDF]
  • Russian: [PDF]

The latest LaTeX source is available through the Git repository.

Debian Menu System

This manual describes the Debian Menu System and the menu package.

The menu package was inspired by the install-fvwm2-menu program from the old fvwm2 package. However, menu tries to provide a more general interface for menu building. With the update-menus command from this package, no package needs to be modified for every X window manager again, and it provides a unified interface for both text- and X-oriented programs.

Authors: Joost Witteveen, Joey Hess, Christian Schwarz
Maintainer: Joost Witteveen
Status: ready
Availability: Debian package menu HTML online

Debian Installer internals

This document is intended to make Debian Installer more accessible to new developers and as a central location to document technical information.

Authors: Frans Pop
Maintainer: Debian Installer team
Status: ready
Availability:

HTML online

DocBook XML source online

dbconfig-common documentation

This document is intended for package maintainers who maintain packages that require a working database. Instead of implementing the required logic themselves they can rely on dbconfig-common to ask the right questions during install, upgrade, reconfigure and deinstall for them and create and fill the database.

Authors: Sean Finney and Paul Gevers
Maintainer: Paul Gevers
Status: ready
Availability: Debian package dbconfig-common
Latest version:

The latest SGML source is available through the Git repository.

Additional also the design document is available.

dbapp-policy

A proposed policy for packages that depend on a working database.

Authors: Sean Finney
Maintainer: Paul Gevers
Status: draft
Availability: Debian package dbconfig-common
Latest version:

The latest SGML source is available through the Git repository.

Debian Live Manual

This document describes the build of Debian live images.

FIXME: debian-live team: please add some useful short description here! FIXME

Authors: Debian Live Team
Maintainer: Debian Live Team
Status: ready
Availability: Debian package live-manual
Latest version:

The latest XML source is available through the Git repository.

Reply to: