Catmandu icon indicating copy to clipboard operation
Catmandu copied to clipboard

Move parts of the documentation from GitHub wiki to CPAN modules

Open nichtich opened this issue 8 years ago • 4 comments

The current GitHub wiki contains 32 pages, which are compiled based on the table of contents at wiki page "Home" to http://librecat.org/Catmandu. As discussed at the Workshop in Berlin, most of the documentation should be moved to CPAN modules:

  • [x] Catmandu::Introduction
  • [x] https://github.com/LibreCat/Catmandu/wiki/Installation=> Catmandu::Help::Installation
  • [x] https://github.com/LibreCat/Catmandu/wiki/Contribution => Catmandu::Help::Contributing
  • [x] https://github.com/LibreCat/Catmandu/wiki/Development-Setup => Catmandu::Help::Development_Setup
  • [x] https://github.com/LibreCat/Catmandu/wiki/Patch-Submission => Catmandu::Help::Patch_Submission
  • [ ] https://github.com/LibreCat/Catmandu/wiki/Concepts=> Catmandu::Help::Glossary
  • [ ] https://github.com/LibreCat/Catmandu/wiki/Fixes-Cheat-Sheet=> Catmandu::Help::Cheatsheet (section "Fixes")
  • [ ] https://github.com/LibreCat/Catmandu/wiki/Command-line-client-Cheat-Sheet=> Catmandu::Help::Cheatsheet (section "Command line")

etc.

Content of these modules can then be

nichtich avatar Apr 11 '16 18:04 nichtich

created Catmandu::Help::Installation, see pr #289

jorol avatar Feb 24 '17 13:02 jorol

added Catmandu::Help::Contribtution, Catmandu::Help::Development_Setup and Catmandu::Help::Patch_Submission in pr #290

jorol avatar Feb 27 '17 10:02 jorol

The help modules are in an unreleased and unmerged branch - what's the plan to make them public?

nichtich avatar Feb 26 '18 10:02 nichtich

Is there a good plan how to maintain these man pages? I see still people contributing to the Wiki page. What is needed is that we need to decide to keep or kill the Wiki, have a way to publish these man pages as HTML pages on our website.

phochste avatar Feb 26 '18 14:02 phochste