Project

General

Profile

Bug #5329

Update documentation

Added by Marco Mambelli over 5 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
Start date:
02/03/2014
Due date:
% Done:

0%

Estimated time:
First Occurred:
Occurs In:
Stakeholders:
Duration:

Description

I'd like to review the documentation and remove or mark as obsolete parts that don't correspond any more to the software or to current practices, e.g. use of pacman.

I started some changes in a branch off master: master_marco_doc
I decided to start with html documents and will change also the glideinWMS.ini template to match updated recommendation

Here I have some questions:
Pacman can be removed as installation method for the dependencies (no more supportedm there are RPM and tar balls). Correct?
Are the pacman options still mandatory (with empty value but in the file)?

HTCondor is not making GCB available any more. Should I remove the section? Should there be something else instead?

Same for Quill. Can the section be removed?

History

#1 Updated by Parag Mhashilkar over 5 years ago

  • Subject changed from Update docuentation to Update documentation
  • Category set to Documentation
  • Assignee set to Marco Mambelli
  • Target version set to v3_2_4

#2 Updated by Marco Mambelli over 5 years ago

Updated documentation, consistency, links, general updates
- Name is GlideinWMS
- Uniform component names (User Pool, WMS Pool, ...)
- HTCondor instead of Condor
- updated links to condor manual
- no more dead links
- more links to RPM installs
- Pacman no more available
- removed GCB section
- kept quill but did not check its validity/did not update
- GIT command instead of CVS

I checked w/ Parag and there are no plans to replace Pacman OSG Client installation w/ the tarball one.
The current documents suggest to pre-install OSG Client and point to OSG documentation.

Remaining TODO:
- documentation.html:
List articles about GlideinWMS in the documentation list.
Suggest an article for references to GlideinWMS (people that have to cite it in papers)
And maybe add it also in the documents footer

Something to think more long term could be the possibility to move the documentation to a templating system:
- something like template-toolkit (http://template-toolkit.org/python/index.html) or jekyll (http://jekyllrb.com/docs/templates/)
- the result are static pages like the current ones
- it allows inclusions and variables that would make document maintenance easier

#3 Updated by Marco Mambelli over 5 years ago

  • Status changed from New to Feedback
  • Assignee changed from Marco Mambelli to Parag Mhashilkar

#4 Updated by Parag Mhashilkar over 5 years ago

  • Assignee changed from Parag Mhashilkar to Marco Mambelli

Sent feedback to Marco.

#5 Updated by Marco Mambelli over 5 years ago

  • Status changed from Feedback to Closed

I changed the documents according to Parag's feedback and merged master_marco_doc in branch_v3_2.
Closing the ticket



Also available in: Atom PDF