Welcome to the Cumulus Support forum.

Latest Cumulus MX release v3.4.6 (build 3070) - 23 March 2020
Legacy Cumulus 1 release v1.9.4 (build 1099) - 28 November 2014

See the Wiki for downloading either version.

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: 6134
Joined: Thu 07 Jan 2010 9:44 pm
Weather Station: Davis VP2
Operating System: Stretch Lite rPi
Location: Wilmslow, Cheshire, UK
Contact:

Volunteers Please - Cumulus MX Documentation

Post by mcrossley » Sat 29 Feb 2020 6:02 pm

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: 163
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 » Sun 01 Mar 2020 9:00 am

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: 218
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 » Sun 01 Mar 2020 9:45 am

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: 577
Joined: Fri 27 Jul 2012 11:29 am
Weather Station: Modified Fine Offset
Operating System: Win. 10 PC
Location: The Marches, UK

Re: Volunteers Please - Cumulus MX Documentation

Post by sfws » Wed 18 Mar 2020 9:41 pm

see viewtopic.php?f=27&t=17837#p138707

Maybe I've posted in the wrong topic, but the above post describes how I have worked in the Wiki on the Cumulus MX page, the FAQ page, and the various log file pages.

It also includes a further appeal for people to contribute.

Can I add here that there is a FAQ section on the wiki {EDIT - see my later post, I had wrong page reference here, sorry, but even I don't know what is available on the Wiki if it is not linked from the main page}. I have added a number of points from my scanning of this MX sub-forum. All of them need to be expanded into proper answers by somebody who understands the individual issue. So now you have some pointers towards where you could contribute.
prodata wrote:
Sun 01 Mar 2020 9:45 am
is illustrated with screenshots
In the past, I did lots of screenshots from Cumulus 1 and added them to the Wiki https://cumuluswiki.org/a/Cumulus_Screenshots. Several no longer display a picture. So there is a need to check which pictures don't work (it appears to be any .jpg) and sort that out.

Somebody who uses MX and has better expertise than me on inserting pictures files into a Wiki should up load some pictures of the various MX screens, then I or another can add them to articles.
Last edited by sfws on Thu 26 Mar 2020 6:54 am, edited 2 times in total.

sfws
Posts: 577
Joined: Fri 27 Jul 2012 11:29 am
Weather Station: Modified Fine Offset
Operating System: Win. 10 PC
Location: The Marches, UK

Re: Volunteers Please - Cumulus MX Documentation

Post by sfws » Sun 22 Mar 2020 5:41 pm

I have been checking against John's suggestions, initially working from the page that the wiki link at the top of this page goes to, and then discovering other pages that exist but are not listed there:
prodata wrote:
Sun 01 Mar 2020 9:45 am
might really benefit from a basic page ... that just explains what CMX is and does;
The Wiki has https://cumuluswiki.org/a/About_Cumulus which seemed to meet your description, other than it was somewhat out of date and focussed on Steve Loft's view of what his Cumulus (1) package did. I have tried to update it, and I hope it meets this requirement.
prodata wrote:
Sun 01 Mar 2020 9:45 am
there's no resource out there at present that provides a simple, accessible summary of CMX and its features
Same answer.
prodata wrote:
Sun 01 Mar 2020 9:45 am
follow up on any more detailed instructions that may be provided separately.
When there was a threat of us losing the support forum in October 2018, Mark kindly (after an exchange of PMs with me) copied a lot of what Steve Loft had posted on the forum into the wiki.

There are two relevant articles he originated https://cumuluswiki.org/a/Cumulus_MX_FAQ and https://cumuluswiki.org/a/Cumulus_MX. Both related to how MX was as first originated by Steve Loft, neither forum post was fully updated by Steve Loft as he continued the development, so in copying from the forum to the Wiki this obsolescence was maintained.

I have done a lot of updates to the latter, the Cumulus MX article, and even included my own experiences of installing MX. I hope that now provides the detailed instructions that John Dunn suggested were needed. However, somebody who uses Linus or Mac environments needs to add their experience to complete the information available.

On the former, the MX FAQ article, Mark Crossley has taken out (last December when he started work on MX) some items relating to old versions of Mono etc. but I think it still probably needs updating to reflect all the considerable work Mark has done since them. I have made some suggestions at the top of the page, but only somebody with experience can sort this page out.
ExperiMentor wrote:
Sun 01 Mar 2020 9:00 am
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.
Thank you for the offer, do my suggestions above give you the leadership advice you need to contribute, perhaps from your raspberian experience?
With lots of sunshine forecast this week, I suspect I will spend more time in the garden than on my PC!

Post Reply