Welcome to the Cumulus Support forum.

Latest Cumulus MX release 3.11.2 (build 3131) - 16 May 2021 (please see announcement regarding releases since 3.5.0)
Legacy Cumulus 1 release v1.9.4 (build 1099) - 28 November 2014 (a patch is available for 1.9.4 build 1099 that extends the date range of drop-down menus to 2030)

Download the Software (Cumulus MX / Cumulus 1 and other related items) from the Wiki

Volunteers Please - Cumulus MX Documentation

Please use this Forum to make suggestions for the future updates additions and general maintenance of the Wiki. Since I am sure most of these will be valid suggestions, so as they are completed in the Wiki the Topic will be deleted from this Forum, and this will act as reminder to anyone updating the Wiki of the jobs still to be done.
Post Reply
User avatar
mcrossley
Posts: 8355
Joined: Thu 07 Jan 2010 9:44 pm
Weather Station: Davis VP2/WLL
Operating System: Buster Lite rPi
Location: Wilmslow, Cheshire, UK
Contact:

Volunteers Please - Cumulus MX Documentation

Post by mcrossley »

I am acutely aware that Cumulus MX is badly lacking in the documentation area. I'm busy patching bugs and adding C1 catch-up features, so do we have a small group of people who are willing to put some time into creating this?

I see two areas...
  • A manual type document, with sections on say getting started, different platforms, and the various station configs. Then further sections explaining basic setup.
  • Maybe some short videos showing the "how-to's"
Now a lot of this information is already available spread across forum posts and the Wiki. The obvious solution for me would be a new section in the Wiki, that pulls all the information together, gets rid of old redundant stuff, and presents it in logical manner.

Its a big task, but that's why I cannot do it by myself.

Over to you guys and gals.

ExperiMentor
Posts: 213
Joined: Tue 24 Nov 2015 11:30 pm
Weather Station: Fine Offset & Davis Vantage Vue
Operating System: Windows 10; Raspbian Buster
Location: Switzerland

Re: Volunteers Please - Cumulus MX Documentation

Post by ExperiMentor »

I'd be happy to give some help, but also cannot do it alone.
I'd need someone else to lead the project and advise how to get started.

Completely agree that the best use of Mark's time is the actual program development (and answering the difficzult questions the rest of us cannot ...)

Ian

prodata
Posts: 280
Joined: Sat 05 Feb 2011 7:13 pm
Weather Station: VP2
Operating System: Windows - all flavours
Location: Littleport, East Cambs, UK

Re: Volunteers Please - Cumulus MX Documentation

Post by prodata »

This is a great idea, albeit one that I don't have the expertise to contribute to myself.

But could I make a plea not to overlook the simple, obvious stuff in any webpage/documentation/video. There are many weather station users out there (not always the most expert of computer users) who are not yet familiar with CMX and might really benefit from a basic page or short video that just explains what CMX is and does; what its main features are; and is illustrated with screenshots. This doesn't need to be minutely detailed - just a summary of the main basics.

Potential users would then find it a lot easier to decide whether to explore CMX further and follow up on any more detailed instructions that may be provided separately. As far as I'm aware, there's no resource out there at present that provides a simple, accessible summary of CMX and its features. The lack of such a summary is very possibly limiting the number of users who reach the point of checking out CMX.
John Dann
Prodata Weather Systems
Littleport, East Cambs, UK
http://www.weatherstations.co.uk

sfws
Posts: 991
Joined: Fri 27 Jul 2012 11:29 am
Weather Station: Combination Mix of FO stations
Operating System: R Pi OS

Re: Volunteers Please - Cumulus MX Documentation

Post by sfws »

A renewed call for contributors

The Cumulus Wiki has a long history of contributors starting on a big plan of creating new pages, and updating existing pages. The problem each contributor meets is that maintaining the Wiki is a massive task, especially when you have a developer continually moving the target. I have done a re-organisation of the Wiki, although it is not as complete as I would like because of the limited rights a standard user has. Each contributor has to stop sometime, and the content then gets out of date unless others contribute.

Please can several people volunteer to share the big job of working through release announcements (since June 2020) and updating pages. EDIT:Changed that from "someone" to "several people"

The Wiki is currently not friendly for newcomers who only have experience of MX. What is missing is a total redesign of the Wiki. That is a huge task, but there are people out there who have knowledge of rival weather software, who should be able to document the pros and cons of MX, and https://www.wxforum.net/index.php?board=118.0 might give some hints.

Please can several people with necessary experience share the big job of documenting features of MX not yet documented, especially relating to weather station types or sensors not supported by legacy software.
Last edited by sfws on Mon 12 Apr 2021 10:39 am, edited 1 time in total.

User avatar
saratogaWX
Posts: 1072
Joined: Wed 06 May 2009 5:02 am
Weather Station: Davis Vantage Pro Plus
Operating System: Windows 10 Professional
Location: Saratoga, CA, USA
Contact:

Re: Volunteers Please - Cumulus MX Documentation

Post by saratogaWX »

Dear sfws,

I've heard your plea above. Since you are active, involved and knowledgeable, I've added you to the Administrators group on the Wiki. You now have the power to change/reorganize as needed. Thanks for your continuing efforts to make the Cumulus Wiki a useful knowledge base.

Best regards,
Ken (hoster, admin for cumuluswiki.org)

sfws
Posts: 991
Joined: Fri 27 Jul 2012 11:29 am
Weather Station: Combination Mix of FO stations
Operating System: R Pi OS

Re: Volunteers Please - Cumulus MX Documentation

Post by sfws »

saratogaWX wrote:
Fri 22 Jan 2021 10:43 pm
Dear sfws,

I've heard your plea above. Since you are active, involved and knowledgeable, I've added you to the Administrators group on the Wiki. You now have the power to change/reorganize as needed. Thanks for your continuing efforts to make the Cumulus Wiki a useful knowledge base.

Best regards,
Ken (hoster, admin for cumuluswiki.org)
Thank you for all those points.

When the ownership of the Cumulus Wiki swapped from Steve to Ken, Steve's beta MX offered a subset of the functionality in Steve's Cumulus 1.
The vast majority of Cumulus users at that time were still using the legacy software, and those who did use the beta wanted to know how it diverged from the legacy software they knew so well. The Wiki structure appropriate for that was just a single page devoted purely to MX, with a few references to MX on various pages created for the original software.

----------------------------------------------------------------------------------------------

The current MX has diverged so much from that beta, and the majority of those who consult the Wiki know nothing about the legacy software. They cannot understand why the original pages, that were created when MX did not exist, talk about menu choices, and files that they cannot find in MX.
I have created multiple pages for different aspects of MX documentation, this is a starting point to a structure fit for future readers and contributors.

Administrator rights have given me the chance to complete my major reorganisation:
1. On the main page I have separated links to MX pages and legacy pages
2. There are now separate category pages explicitly for Cumulus 1 and for MX, so contributors without admin rights can link to those categories, and thus be linked to the main page.
3. I have added protection to pages which document aspects of the legacy software that do not apply to MX, so the standard contributor will edit the correct MX pages not the legacy pages.
4. As MX has changed so much from how it was in early 2020, when I created the new MX pages, I have added banner messages, indicating where I am aware my text is out of date.

As earlier posts in this thread suggest, what is needed next is documentation for the following readers
  • People who have no knowledge of Cumulus and considering whether to try MX,
  • People who want documentation to cover all the new functionality that has been added in the development of MX
I am not the right person to do such documentation for MX, as I use almost none of the new MX functionality, and I use an obsolete weather station type. At bottom of Wiki main page, there are links to advice to help any potential Wiki contributor to get started e.g. The Wiki has almost no information for those who have a Davis weather station.

My main reason for my previous posting was to repeat pleas for others to contribute.
Any potential Wiki contributors should, in general, create new pages for MX rather than remove (or edit) the legacy content.
  • I want others to take up the chore of keeping the Cumulus Wiki up to date,
  • MX has changed drastically making many existing pages out of date
  • Somebody, with video making experience, should take up the much needed challenges suggested by developer Mark and by prodata (John Dann) in their respective posts in this topic.

Post Reply