You are here: Foswiki>Tasks Web>Item717 (23 Feb 2009, KennethLavrsen)Edit Attach

Item717: Copy edits to Foswiki install and upgrade documentation

pencil
Priority: Low
Current State: Closed
Released In: 1.0.1
Target Release: patch
Applies To: Engine
Component: Documentation
Branches:
Reported By: IsaacLin
Waiting For: Foswiki:Main.IsaacLin
Last Change By: KennethLavrsen
Various copy edits to improve the legibility and organization of the following topics:
  • InstallationGuide
    • Changed from a numbered list with a lot of content in each item to a numbered list with a one-line description of the step, and with following sections to expand on each step.
    • Re-organized how the steps are grouped. Consolidated redundant steps into one location.
    • Moved setting up authentication and defining an admin user into the basic installation. (Setting up authentication is tagged as optional.)
    • Copy edits: Improve conciseness and clarity; eliminate duplication of instructions. (Explanations of what the installer should expect is duplicated where it seems appropriate.)
  • UpgradeGuide
    • Re-organized how the steps are grouped. Consolidated redundant steps into one location.
    • Copy edits: Improve conciseness and clarity; eliminate duplication of instructions.
  • AdminSkillsAssumptions
    • Expanded on assumptions: Unix admin knowledge required even for Windows installers (InstallationGuide and UpgradeGuide are written assuming it; Windows installers must be able to map the instructions to equivalent Windows commands), understanding of web server execution environment and security required.
  • ManagingTopics
    • Added documentation on how to copy a topic. (Referred to from the InstallationGuide.)
Topic revision: r20 - 23 Feb 2009, KennethLavrsen
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy