diff options
author | Thomas Lange <lange@debian.org> | 2019-03-21 07:27:12 +0000 |
---|---|---|
committer | Thomas Lange <lange@debian.org> | 2019-03-21 07:27:12 +0000 |
commit | 5a0eda184797f59ffcd7daa4ebb32efc4f0bc36c (patch) | |
tree | 144ea840f5b79fa64a22f4b812d03401744af515 | |
parent | 39ae07f8924d5117fbaabbb20fcfcc1bdf0dac8e (diff) | |
parent | 63b253e9f683a3e51632a8be03911a02d53a936e (diff) |
Merge branch 'pu/doc-rename' into 'master'
Add page rename support and direct doc/cvs to doc/vcs
See merge request webmaster-team/webwml!73
-rw-r--r-- | english/doc/Makefile | 1 | ||||
-rw-r--r-- | english/doc/cvs.wml | 106 | ||||
-rw-r--r-- | english/doc/manuals.defs | 26 | ||||
-rw-r--r-- | english/doc/vcs.wml | 103 | ||||
-rw-r--r-- | english/template/debian/redirect.wml | 31 |
5 files changed, 151 insertions, 116 deletions
diff --git a/english/doc/Makefile b/english/doc/Makefile index 7c589eabb49..37b1f272b0e 100644 --- a/english/doc/Makefile +++ b/english/doc/Makefile @@ -16,6 +16,7 @@ books.$(LANGUAGE).html: books.wml $(ENGLISHSRCDIR)/doc/books.def \ ddp.$(LANGUAGE).html: ddp.wml $(TEMPLDIR)/ddp.wml todo.$(LANGUAGE).html: todo.wml $(TEMPLDIR)/ddp.wml docpolicy.$(LANGUAGE).html: docpolicy.wml $(TEMPLDIR)/ddp.wml +vcs.$(LANGUAGE).html: vcs.wml $(TEMPLDIR)/ddp.wml cvs.$(LANGUAGE).html: cvs.wml $(TEMPLDIR)/ddp.wml topics.$(LANGUAGE).html: topics.wml $(TEMPLDIR)/ddp.wml user-manuals.$(LANGUAGE).html: user-manuals.wml $(TEMPLDIR)/ddp.wml \ diff --git a/english/doc/cvs.wml b/english/doc/cvs.wml index 195f684f9c6..86c4fcd84c9 100644 --- a/english/doc/cvs.wml +++ b/english/doc/cvs.wml @@ -1,105 +1 @@ -#use wml::debian::ddp title="Debian Documentation Project VCS" -#use wml::debian::toc - -<p>The Debian Documentation Project stores its web pages and much of the -manual text on the Debian Salsa service at -<strong>salsa.debian.org</strong>, which is Debian's GitLab instance. -Please read the <a href="https://wiki.debian.org/Salsa">Salsa documentation</a> -for more information about how this service works. -</p> - -<p>Everybody can download the sources from the Salsa service. Only members of -the Debian Documentation Project can update files.</p> - -<toc-display /> - -<toc-add-entry name="access">Accessing the sources in git</toc-add-entry> - -<p>You can use a web interface to access the files individually and -see changes on each project at -<url "https://salsa.debian.org/ddp-team/" /></p> - -<p>For downloading an entire manual, direct access to the git server -is often a better option. You need the -<tt><a href="https://packages.debian.org/git">git</a></tt> package on your -own machine.</p> - -<h3>Cloning a git repository anonymously (read-only)</h3> - -<p>Use this command to download all the files for one project:</p> - -<p style="margin-left: 2em"> - <code>git clone https://salsa.debian.org/ddp-team/release-notes.git</code> -</p> - -<p>Do the same for every project you want to clone locally.</p> - -<h3>Cloning a git repository with push privileges (read-write)</h3> - -<p>Before accessing the git server using this method you have to be -granted write access to it first. Please read how to <a -href="#obtaining">request</a> push permission first.</p> - -<p>Use this command to download all the files for one project:</p> - -<p style="margin-left: 2em"> - <code>git clone git@salsa.debian.org:ddp-team/release-notes.git</code> -</p> - -<p>Do the same for every project you want to clone locally.</p> - -<h3>Fetching changes from the remote git repository</h3> - -<p>To update your local copy with any changes made by other people, enter -the <strong>manuals</strong> directory and run the command:</p> - -<p style="margin-left: 2em"> - <code>git pull</code> -</p> - -<toc-add-entry name="obtaining">Obtaining push privileges</toc-add-entry> - -<p>Push privileges are available to anyone who wishes to participate in -writing the manuals. We generally request that you have submitted -a couple of useful patches first.</p> - -<p>After creating your account on <a href="https://salsa.debian.org/">Salsa</a>, -please request push privileges by clicking <q>Request to join</q> on the -group or any of the specific projects under -<url "https://salsa.debian.org/ddp-team/" />. -Please follow it up with an email to debian-doc@lists.debian.org explaining -the track record of your work on Debian.</p> - -<p>Once your request is approved, you'll be part of either the <a -href="https://salsa.debian.org/ddp-team/"><q>ddp-team</q> group</a> or -one of its projects. -</p> - -<hr /> - -<toc-add-entry name="updates">Automatic update mechanism</toc-add-entry> - -<p>The published web pages of the manual text are generated on -www-master.debian.org as part of the regular web site rebuilding process, -which happens every four hours.</p> - -<p>The script does a <kbd>svn export --force svn://svn.debian.org/svn/ddp/manuals</kbd>, and then -<kbd>make -C trunk publish</kbd>.</p> - -<p>The makefile is set up to rebuild each subdirectory (that contains -maintained documentation), and to install the files from each subdirectory -in <code>doc/manuals/</code> subdirectory of the web site. The subdirectory -makefiles are derived from <code>manuals/standard.makefile</code>.</p> - -<p>The documentation files generated by the update script can be found at -<a href="manuals/">https://www.debian.org/doc/manuals/</a>.</p> - -<p>The log files generated by the update script can be found at -<url "https://www-master.debian.org/build-logs/ddp/" /></p> - -<p>Note that this process regenerates the <code>/doc/manuals/</code> -directory. The contents of the <code>/doc/</code> directory is generated -either from <a href="/devel/website/desc">webwml</a> or from other scripts, -such as those which extract certain manuals from their packages.</p> - -# <!-- Created: Mon Jul 6 19:58:09 BST 1998 --> +#use wml::debian::redirect newpage="vcs" diff --git a/english/doc/manuals.defs b/english/doc/manuals.defs index 075b4b38975..6439f6ae25f 100644 --- a/english/doc/manuals.defs +++ b/english/doc/manuals.defs @@ -58,17 +58,20 @@ </tr> </define-tag> +# Alias for inddpcvs for those looking for 'cvs' here +<define-tag inddpcvs whitespace=delete> + <inddpvcs %attributes> +</define-tag> + # Alias for inddpsvn for those looking for 'svn' here <define-tag inddpsvn whitespace=delete> - <inddpcvs %attributes> + <inddpvcs %attributes> </define-tag> -# NOTE defined as 'inddpcvs' although now the repo is SVN -# kept to minimise the number of changes in the pages -<define-tag inddpcvs whitespace=delete> - <preserve name index baselink langs formats basename path loc txt version cvsname naming srctype vcstype vcsweb vcsrepo /> +<define-tag inddpvcs whitespace=delete> + <preserve name index baselink langs formats basename path loc txt version cvsname naming srctype vcsname vcstype vcsweb vcsrepo /> <set-var %attributes /> - <if <get-var name /> "" <exit message="you must pass a name to the inddpcvs tag" /> /> + <if <get-var name /> "" <exit message="you must pass a name to the inddpvcs tag" /> /> # Default values <defvar index index /> <if <get-var langs /> @@ -78,7 +81,8 @@ <defvar formats html /> <defvar path "manuals/<get-var name />" /> <defvar basename "<get-var name />" /> - <defvar cvsname <get-var name /> /> + <defvar cvsname <get-var name /> /> # Deprecated variable, alias for vcsname + <defvar vcsname <get-var cvsname /> /> # naming: default(extention: pt-br, ...), locale(extention: pt_BR, ...), none(no listing) <defvar naming default /> <defvar srctype XML /> @@ -139,7 +143,7 @@ </when> [<a href="<get-var path />/<get-var loc />"><get-var txt /></a>] # <if <match <get-var format /> "(html|txt|pdf|ps)" action=report /> "" -# <exit message="you must pass a valid format to the inddpcvs tag" /> +# <exit message="you must pass a valid format to the inddpvcs tag" /> # /> </foreach> </li> @@ -149,8 +153,8 @@ </when> # DDP Git repo access (used) <when <match <get-var vcstype /> "ddp" action=report />> - <set-var vcsweb="https://salsa.debian.org/ddp-team/<get-var cvsname />" /> - <set-var vcsrepo="https://salsa.debian.org/ddp-team/<get-var cvsname />.git" /> + <set-var vcsweb="https://salsa.debian.org/ddp-team/<get-var vcsname />" /> + <set-var vcsrepo="https://salsa.debian.org/ddp-team/<get-var vcsname />.git" /> <p><gettext domain="doc">The latest <get-var srctype /> source is available through the <a href="https://packages.debian.org/git">Git</a> repository.</gettext></p> <ul> <li><gettext domain="doc">Web interface: </gettext><a href="<get-var vcsweb />"><get-var vcsweb /></a></li> @@ -181,7 +185,7 @@ <li><gettext domain="doc">VCS interface: </gettext><tt>git clone <get-var vcsrepo /></tt></li> </ul> </when> - <restore name index baselink langs formats basename path loc txt version cvsname naming srctype vcstype vcsweb vcsrepo /> + <restore name index baselink langs formats basename path loc txt version cvsname naming srctype vcsname vcstype vcsweb vcsrepo /> </define-tag> <define-tag inbfdcvs> diff --git a/english/doc/vcs.wml b/english/doc/vcs.wml new file mode 100644 index 00000000000..0a313b05a24 --- /dev/null +++ b/english/doc/vcs.wml @@ -0,0 +1,103 @@ +#use wml::debian::ddp title="Debian Documentation Project VCS" +#use wml::debian::toc + +<p>The Debian Documentation Project stores its web pages and much of the +manual text on the Debian Salsa service at +<strong>salsa.debian.org</strong>, which is Debian's GitLab instance. +Please read the <a href="https://wiki.debian.org/Salsa">Salsa documentation</a> +for more information about how this service works. +</p> + +<p>Everybody can download the sources from the Salsa service. Only members of +the Debian Documentation Project can update files.</p> + +<toc-display /> + +<toc-add-entry name="access">Accessing the sources in git</toc-add-entry> + +<p>You can use a web interface to access the files individually and +see changes on each project at +<url "https://salsa.debian.org/ddp-team/" /></p> + +<p>For downloading an entire manual, direct access to the git server +is often a better option. You need the +<tt><a href="https://packages.debian.org/git">git</a></tt> package on your +own machine.</p> + +<h3>Cloning a git repository anonymously (read-only)</h3> + +<p>Use this command to download all the files for one project:</p> + +<p style="margin-left: 2em"> + <code>git clone https://salsa.debian.org/ddp-team/release-notes.git</code> +</p> + +<p>Do the same for every project you want to clone locally.</p> + +<h3>Cloning a git repository with push privileges (read-write)</h3> + +<p>Before accessing the git server using this method you have to be +granted write access to it first. Please read how to <a +href="#obtaining">request</a> push permission first.</p> + +<p>Use this command to download all the files for one project:</p> + +<p style="margin-left: 2em"> + <code>git clone git@salsa.debian.org:ddp-team/release-notes.git</code> +</p> + +<p>Do the same for every project you want to clone locally.</p> + +<h3>Fetching changes from the remote git repository</h3> + +<p>To update your local copy with any changes made by other people, enter +the <strong>manuals</strong> directory and run the command:</p> + +<p style="margin-left: 2em"> + <code>git pull</code> +</p> + +<toc-add-entry name="obtaining">Obtaining push privileges</toc-add-entry> + +<p>Push privileges are available to anyone who wishes to participate in +writing the manuals. We generally request that you have submitted +a couple of useful patches first.</p> + +<p>After creating your account on <a href="https://salsa.debian.org/">Salsa</a>, +please request push privileges by clicking <q>Request to join</q> on the +group or any of the specific projects under +<url "https://salsa.debian.org/ddp-team/" />. +Please follow it up with an email to debian-doc@lists.debian.org explaining +the track record of your work on Debian.</p> + +<p>Once your request is approved, you'll be part of either the <a +href="https://salsa.debian.org/ddp-team/"><q>ddp-team</q> group</a> or +one of its projects. +</p> + +<hr /> + +<toc-add-entry name="updates">Automatic update mechanism</toc-add-entry> + +<p>The published web pages of the manual text are generated on +www-master.debian.org as part of the regular web site rebuilding process, +which happens every four hours.</p> + +<p>The script does a <kbd>svn export --force svn://svn.debian.org/svn/ddp/manuals</kbd>, and then +<kbd>make -C trunk publish</kbd>.</p> + +<p>The makefile is set up to rebuild each subdirectory (that contains +maintained documentation), and to install the files from each subdirectory +in <code>doc/manuals/</code> subdirectory of the web site. The subdirectory +makefiles are derived from <code>manuals/standard.makefile</code>.</p> + +<p>The documentation files generated by the update script can be found at +<a href="manuals/">https://www.debian.org/doc/manuals/</a>.</p> + +<p>The log files generated by the update script can be found at +<url "https://www-master.debian.org/build-logs/ddp/" /></p> + +<p>Note that this process regenerates the <code>/doc/manuals/</code> +directory. The contents of the <code>/doc/</code> directory is generated +either from <a href="/devel/website/desc">webwml</a> or from other scripts, +such as those which extract certain manuals from their packages.</p> diff --git a/english/template/debian/redirect.wml b/english/template/debian/redirect.wml new file mode 100644 index 00000000000..fcfb3939834 --- /dev/null +++ b/english/template/debian/redirect.wml @@ -0,0 +1,31 @@ +#use wml::debian::basic SUMMARY="$(SUMMARY)" title="Page redirected to $(newpage)" +#use wml::debian::languages + +<define-tag redirect whitespace=delete> + <div class="important"> + <p> + <gettext>This page has been renamed to <url "%0">, please update your links.</gettext> + </p> + </div> +</define-tag> + +{#check_trans#} + +<ifeq "$(NOHEADER)" "" " +<h1>$(title)</h1> +"/> + +{#pre_footer#: +<hrlinehidden/> + +<ifeq "$(NOHOMELINK)" "" " +<p><returnline/></p> +<hrline/> +"/> + +<ifeq "$(NOLANGUAGES)" "" " +<:= languages_footer() :> +"/> +:#pre_footer#} + +<redirect $(newpage)> |