How to improve documentation overall

[bonomani]

Good documentation is crucial for helping new contributors understand how to use the software, set up a development environment, and contribute effectively. This includes README files, user guides, and developer documentation

Inventory

Main Xymon location

• Main Xymon landing page: #18
• Code repo: https://sourceforge.net/projects/xymon/

Xymon demo website )

• The latest Xymon working installation: https://www.xymon.com/
• A lot of custom pages that help to understand the possibilities
• Help and man pages (duplicate with main Xymon landing page)

  Wikibook

• Obsolete
• Url: https://en.wikibooks.org/wiki/System_Monitoring_with_Xymon
• Content:
  • Mainly 3 pages: User guide, administration guide, developer guide, others (FAQ, HOWTO, SLIDES)
  • Obsolete content
  • Lot of things related to BB server: To be remove probably?
  • Not enough focused on Xymon: Ok to have some keywords that can improve Xymon referencing: But less is more...
  • Needs to have a better "Introductory document for developers"
  • Design: Split long pages

Xymonton: a site hosting of add-ons

• 7

  Ideas

  Improve collaboration

• Xymonton seems to be good for collaboration (enrollment in place)
• Wikibook seems also (Not tested as seems obsolete )
• Sourceforge ?

Guide Lines

• No duplicate information
  • Role of each website could be clarified

Proposal: What about fusion both wiki into 1 ?

• Idea: Take the best of each (Wikibook and Xymonton)
  • Are current admin open to such a move ?
• Write some guidelines: goal of the doc and general principles for maintenance
• Start to have:
  • A team responsible for the doc (with admin diversity)
  • Fusion all docs in a solution (TBD)
  • Iterate to have quality and up to date info