From 49468adc9e078833949684fba6ce4a743ae8f5a6 Mon Sep 17 00:00:00 2001 From: Guillem Jover Date: Wed, 11 Jul 2018 15:53:59 +0200 Subject: doc: Rename macro inddpcvs to inddpvcs and cvsname to vcsname Add backward compatibility aliases for both macro and argument so that the call sites do not have to be updated right away causing translation work. But this will make it possible to switch these to a generic macro piece by piece. --- english/doc/manuals.defs | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) 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 @@ +# Alias for inddpcvs for those looking for 'cvs' here + + + + # Alias for inddpsvn for those looking for 'svn' here - + -# NOTE defined as 'inddpcvs' although now the repo is SVN -# kept to minimise the number of changes in the pages - - + + - "" /> + "" /> # Default values @@ -78,7 +81,8 @@ " /> " /> - /> + /> # Deprecated variable, alias for vcsname + /> # naming: default(extention: pt-br, ...), locale(extention: pt_BR, ...), none(no listing) @@ -139,7 +143,7 @@ [] # "(html|txt|pdf|ps)" action=report /> "" -# +# # /> @@ -149,8 +153,8 @@ # DDP Git repo access (used) "ddp" action=report />> - - + +

The latest source is available through the Git repository.

  • Web interface:
    • @@ -181,7 +185,7 @@
  • VCS interface: git clone
- + -- cgit v1.2.3 From 49505301a59910f7d0772a52219bfabfd50fd508 Mon Sep 17 00:00:00 2001 From: Guillem Jover Date: Wed, 11 Jul 2018 15:58:02 +0200 Subject: templates: Add debian/redirect.wml This new template can be used to redirect old pages to new ones, so that we do not leave dangling links to our pages, and users unable to know where the new stuff went to. --- english/template/debian/redirect.wml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 english/template/debian/redirect.wml 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 + + +
+

+ This page has been renamed to , please update your links. +

+
+ + +{#check_trans#} + +$(title) +"/> + +{#pre_footer#: + + +

+ +"/> + + +"/> +:#pre_footer#} + + -- cgit v1.2.3 From 63b253e9f683a3e51632a8be03911a02d53a936e Mon Sep 17 00:00:00 2001 From: Guillem Jover Date: Wed, 11 Jul 2018 15:58:02 +0200 Subject: doc: Rename doc/cvs.wml to doc/vcs.wml Keep the original in place with a text to redirect users to the new page. --- english/doc/Makefile | 1 + english/doc/cvs.wml | 106 +-------------------------------------------------- english/doc/vcs.wml | 103 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 105 insertions(+), 105 deletions(-) create mode 100644 english/doc/vcs.wml 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 - -

The Debian Documentation Project stores its web pages and much of the -manual text on the Debian Salsa service at -salsa.debian.org, which is Debian's GitLab instance. -Please read the Salsa documentation -for more information about how this service works. -

- -

Everybody can download the sources from the Salsa service. Only members of -the Debian Documentation Project can update files.

- - - -Accessing the sources in git - -

You can use a web interface to access the files individually and -see changes on each project at -

- -

For downloading an entire manual, direct access to the git server -is often a better option. You need the -git package on your -own machine.

- -

Cloning a git repository anonymously (read-only)

- -

Use this command to download all the files for one project:

- -

- git clone https://salsa.debian.org/ddp-team/release-notes.git -

- -

Do the same for every project you want to clone locally.

- -

Cloning a git repository with push privileges (read-write)

- -

Before accessing the git server using this method you have to be -granted write access to it first. Please read how to request push permission first.

- -

Use this command to download all the files for one project:

- -

- git clone git@salsa.debian.org:ddp-team/release-notes.git -

- -

Do the same for every project you want to clone locally.

- -

Fetching changes from the remote git repository

- -

To update your local copy with any changes made by other people, enter -the manuals directory and run the command:

- -

- git pull -

- -Obtaining push privileges - -

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.

- -

After creating your account on Salsa, -please request push privileges by clicking Request to join on the -group or any of the specific projects under -. -Please follow it up with an email to debian-doc@lists.debian.org explaining -the track record of your work on Debian.

- -

Once your request is approved, you'll be part of either the ddp-team group or -one of its projects. -

- -
- -Automatic update mechanism - -

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.

- -

The script does a svn export --force svn://svn.debian.org/svn/ddp/manuals, and then -make -C trunk publish.

- -

The makefile is set up to rebuild each subdirectory (that contains -maintained documentation), and to install the files from each subdirectory -in doc/manuals/ subdirectory of the web site. The subdirectory -makefiles are derived from manuals/standard.makefile.

- -

The documentation files generated by the update script can be found at -https://www.debian.org/doc/manuals/.

- -

The log files generated by the update script can be found at -

- -

Note that this process regenerates the /doc/manuals/ -directory. The contents of the /doc/ directory is generated -either from webwml or from other scripts, -such as those which extract certain manuals from their packages.

- -# +#use wml::debian::redirect newpage="vcs" 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 + +

The Debian Documentation Project stores its web pages and much of the +manual text on the Debian Salsa service at +salsa.debian.org, which is Debian's GitLab instance. +Please read the Salsa documentation +for more information about how this service works. +

+ +

Everybody can download the sources from the Salsa service. Only members of +the Debian Documentation Project can update files.

+ + + +Accessing the sources in git + +

You can use a web interface to access the files individually and +see changes on each project at +

+ +

For downloading an entire manual, direct access to the git server +is often a better option. You need the +git package on your +own machine.

+ +

Cloning a git repository anonymously (read-only)

+ +

Use this command to download all the files for one project:

+ +

+ git clone https://salsa.debian.org/ddp-team/release-notes.git +

+ +

Do the same for every project you want to clone locally.

+ +

Cloning a git repository with push privileges (read-write)

+ +

Before accessing the git server using this method you have to be +granted write access to it first. Please read how to request push permission first.

+ +

Use this command to download all the files for one project:

+ +

+ git clone git@salsa.debian.org:ddp-team/release-notes.git +

+ +

Do the same for every project you want to clone locally.

+ +

Fetching changes from the remote git repository

+ +

To update your local copy with any changes made by other people, enter +the manuals directory and run the command:

+ +

+ git pull +

+ +Obtaining push privileges + +

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.

+ +

After creating your account on Salsa, +please request push privileges by clicking Request to join on the +group or any of the specific projects under +. +Please follow it up with an email to debian-doc@lists.debian.org explaining +the track record of your work on Debian.

+ +

Once your request is approved, you'll be part of either the ddp-team group or +one of its projects. +

+ +
+ +Automatic update mechanism + +

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.

+ +

The script does a svn export --force svn://svn.debian.org/svn/ddp/manuals, and then +make -C trunk publish.

+ +

The makefile is set up to rebuild each subdirectory (that contains +maintained documentation), and to install the files from each subdirectory +in doc/manuals/ subdirectory of the web site. The subdirectory +makefiles are derived from manuals/standard.makefile.

+ +

The documentation files generated by the update script can be found at +https://www.debian.org/doc/manuals/.

+ +

The log files generated by the update script can be found at +

+ +

Note that this process regenerates the /doc/manuals/ +directory. The contents of the /doc/ directory is generated +either from webwml or from other scripts, +such as those which extract certain manuals from their packages.

-- cgit v1.2.3