Project

General

Profile

Actions

Architecture #2397

closed

Clarify download options on web site and in documentation

Added by Jonathan CLARKE almost 12 years ago. Updated almost 12 years ago.

Status:
Released
Priority:
2
Assignee:
Nicolas PERRON
Category:
Documentation
Target version:
Effort required:
Name check:
Fix check:
Regression:

Description

I just noticed that the Download page (http://www.rudder-project.org/foswiki/Download/WebHome) and the documentation section on installing (http://www.rudder-project.org/rudder-doc-2.4/rudder-doc.html#_install_rudder_server) are unclear about several things:

  • The URLs are inconsistent: we should use apt-2.4 in the 2.4 version documentation, not apt-stable (which is currently 2.3, and one day will be 2.5, neither one is 2.4!) (same for rpm-)
  • We should explain about apt-stable and apt-nightly in the download page (same for rpm-)
  • The "echo" commands in both use "squeeze" hard-coded, this should be replaced with "$(lsb_release -cs)" (see https://github.com/Normation/rudder-vagrant/blob/master/provision/node.sh), so that this will work for lenny, squeeze and whatever version of Ubuntu people are using
  • The download page seems to have a very weird structure: 1) package manager, 2) download manually, 3) source, then a new level 1 title, then more sub-sections... I think the whole end of the page should be removed, and we should just refer to the documentation (and thus avoid duplication!)
  • All references to Debian in 2.4 should be upgraded to "Debian or Ubuntu"
Actions #1

Updated by Jonathan CLARKE almost 12 years ago

Looking at this commit on the documentation, I disagree with some changes:
  • You have changed apt-2.3 to apt-stable in the doc for version 2.3. This is incorrect, apt-2.3 is fine in 2.3 documentation, it is apt-2.3 in 2.*4* documentation that should be changed to apt-2.4...
  • At least one of the places where "$(lsb_release -cs)" replaced "squeeze" is in a context like "Check that the file contains this:", so that obviously won't be right
Actions #2

Updated by Matthieu CERDA almost 12 years ago

  • Status changed from New to In progress

I agree with the suggested modifications.

Actions #3

Updated by Nicolas PERRON almost 12 years ago

  • Status changed from In progress to Pending technical review
  • % Done changed from 0 to 100

Jonathan CLARKE wrote:

I just noticed that the Download page (http://www.rudder-project.org/foswiki/Download/WebHome) and the documentation section on installing (http://www.rudder-project.org/rudder-doc-2.4/rudder-doc.html#_install_rudder_server) are unclear about several things:

  • The URLs are inconsistent: we should use apt-2.4 in the 2.4 version documentation, not apt-stable (which is currently 2.3, and one day will be 2.5, neither one is 2.4!) (same for rpm-)

Done

  • We should explain about apt-stable and apt-nightly in the download page (same for rpm-)

Done

Done

  • The download page seems to have a very weird structure: 1) package manager, 2) download manually, 3) source, then a new level 1 title, then more sub-sections... I think the whole end of the page should be removed, and we should just refer to the documentation (and thus avoid duplication!)

Done

  • All references to Debian in 2.4 should be upgraded to "Debian or Ubuntu"

Done

Actions #4

Updated by Matthieu CERDA almost 12 years ago

Well this is kind of ... complicated at the least !

But il looks correct. Thanks NPE.

Actions #5

Updated by Jonathan CLARKE almost 12 years ago

  • Status changed from Pending technical review to Released
Actions

Also available in: Atom PDF