How you can contribute: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (Text replacement - "http://sandaysoft.com/forum/" to "https://cumulus.hosiene.co.uk/")
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
As we are in the early stages of the Wiki, I thought we could make a list of Pages/Articles we would likes to see on the Wiki.  Please feel free to add to the list.  If you wish to work on a new page go into the [[Talk:Pages to Be Written|discussion]] tab and add your name.


Much of the information could be taken from the help files (as a start) and also by working through the forum.
=Original text when Wiki first created=


::This text was inserted by "DAJ" and has been retained, although it was written when MX did not exist.


If you wish to participate but are unsure where to start, please contact [[User:Daj|DAJ]] via his talk page and he can assist with a template/starting point or answer any specific questions.
As we are in the early stages of the Wiki, I thought we could make a list of Pages/Articles we would likes to see on the Wiki.


'''Please feel free to add to/revise the list.'''
*It is useful if the Wiki includes the information found in the Cumulus help in the installation files (as a start), and then make the page more useful by working through the forum looking for answers and hints of general use.
=How to start contributing= 
If you wish to work on a new page, see [[Help:Contents/Editing]] for advice.
It is best to keep pages short, and often you will be creating new pages. Ensure your new page can be found by adding:
*a link to a [[Special:Categories|existing category]]
*a link from an existing page, see [[Help:Contents/Editing]] for advice.
You may see posts in the support forum containing information that you think should be made easier to find.  The Wiki is a good place to put that content.  Think carefully about where to put it:
* should you start a new page,
*or should you add it to an existing page (using a new heading)?
Pages for [[Highcharts_-_Recent|recent graphs]] and [[Highcharts_-_Historic|historic graphs]] were first created  a decade or more ago, and moved to there current page names in 2012, but nobody has got round to adding any documentation on either page.
Any page that has <nowiki>[[Template:WorkInProgressBanner]]</nowiki> on it is waiting for a contributor to do more work there, can you help?
=Got questions?=
If you wish to participate, but are unsure where to start, please contact [[User:saratogaWX|SaratogaWX]] via his talk page, and he can assist with a template/starting point, or answer any specific questions.
If you are unsure whether it is best to start a new page or not (or uncertain what to name your new page),
*go into the [[Talk:How you can contribute|discussion]] tab of this page
*say what you propose, or what you are uncertain about
*and add your '''Wiki name''' and '''date/time''', using multiple tilde characters e.g. <nowiki>~~~~</nowiki> or  <nowiki>~~~~~</nowiki>
*use '''Show Preview''' to check your typing, before you '''Save Changes'''
*Other people can then, join the discussion, and give further advice.
The problem is that people may not be monitoring these discussion pages, so you can also post your suggestion in https://cumulus.hosiene.co.uk/viewforum.php?f=38.


=We are currently looking for:=
=We are currently looking for:=
<br/>
*PHP and Javascript articles
::There are some 3rd party functions described in the wiki and forum that are written in these languages, but very little comparable with existing articles on editing HTML and CSS.
::A posting exists on the forum to gather more information for this page. 
::https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=5306&hilit=javascript


*Web templates
*Pages about all the external sites Cumulus can upload to
::Got a web template you can share with others?
**For example APRS, CWOP, Weather Underground,PWS, Weatherbug and WOW interfacing hints
::Link it in with the page on Creating Templates [[:Category:WebTips]]


*Webcams used with Cumulus
*Pages about using Cumulus with each of the supported [[Supported Devices|Weather stations]]
::A posting exists on the forum to gather some information for this page. 
**Most past contributors have used cheap Fine Offset models, so you will find [[:Category:StationSpecific]] is dominated by those models
::https://cumulus.hosiene.co.uk/viewtopic.php?f=11&t=1260
**MX has greatly extended the devices it supports, but nobody has yet created any pages to cover any of these


*Articles about APRS, CWOP, Weather Underground,PWS, Weatherbug and WOW interfacing hints
*Contributors to update Wiki
**Read Announcements made by developer, and update/create pages, to reflect the announced bug-fixes, and new functionality
***Some pages have boxes that indicate out of date information (often indicating which release they were last updated for)
***New functionality probably merits new pages, the Wiki was created for original Cumulus, and not based around MX functionality


*Further incorporation of hints developed in the support forum (possibly into FAQ page)
*The pros and cons of choosing MX compared with rival weather software
** It has been suggested a video could be made to illustrate all the features in MX
** See posts in https://cumulus.hosiene.co.uk/viewforum.php?f=38 for some hints


*Extra Sensors
*Extra Sensors
::These are covered in the Logs section, but can you add examples of a log file with such extra sensors?
:: Someone needs to write a page explaining how Cumulus 1 handles Extra sensors


*Updates
::MX releases have been refining handling of sensors. Can you write a page explaining how the handling has changed for different MX builds.
::Existing authors have tried to incorporate updates to various pages reflecting the current standard and beta builds of Cumulus, including changes to how you set various settings, but can you spot anywhere else where information is out of date?
::Some parts of various pages have been misunderstood, and rewritten to be clearer, the style has evolved to include more heading structure as pages have grown, maybe you feel other pages need updating?

Latest revision as of 18:25, 17 May 2021

Original text when Wiki first created

This text was inserted by "DAJ" and has been retained, although it was written when MX did not exist.

As we are in the early stages of the Wiki, I thought we could make a list of Pages/Articles we would likes to see on the Wiki.

Please feel free to add to/revise the list.

  • It is useful if the Wiki includes the information found in the Cumulus help in the installation files (as a start), and then make the page more useful by working through the forum looking for answers and hints of general use.

How to start contributing

If you wish to work on a new page, see Help:Contents/Editing for advice.

It is best to keep pages short, and often you will be creating new pages. Ensure your new page can be found by adding:

You may see posts in the support forum containing information that you think should be made easier to find. The Wiki is a good place to put that content. Think carefully about where to put it:

  • should you start a new page,
  • or should you add it to an existing page (using a new heading)?


Pages for recent graphs and historic graphs were first created a decade or more ago, and moved to there current page names in 2012, but nobody has got round to adding any documentation on either page.

Any page that has [[Template:WorkInProgressBanner]] on it is waiting for a contributor to do more work there, can you help?

Got questions?

If you wish to participate, but are unsure where to start, please contact SaratogaWX via his talk page, and he can assist with a template/starting point, or answer any specific questions.


If you are unsure whether it is best to start a new page or not (or uncertain what to name your new page),

  • go into the discussion tab of this page
  • say what you propose, or what you are uncertain about
  • and add your Wiki name and date/time, using multiple tilde characters e.g. ~~~~ or ~~~~~
  • use Show Preview to check your typing, before you Save Changes
  • Other people can then, join the discussion, and give further advice.

The problem is that people may not be monitoring these discussion pages, so you can also post your suggestion in https://cumulus.hosiene.co.uk/viewforum.php?f=38.

We are currently looking for:

  • Pages about all the external sites Cumulus can upload to
    • For example APRS, CWOP, Weather Underground,PWS, Weatherbug and WOW interfacing hints
  • Pages about using Cumulus with each of the supported Weather stations
    • Most past contributors have used cheap Fine Offset models, so you will find Category:StationSpecific is dominated by those models
    • MX has greatly extended the devices it supports, but nobody has yet created any pages to cover any of these
  • Contributors to update Wiki
    • Read Announcements made by developer, and update/create pages, to reflect the announced bug-fixes, and new functionality
      • Some pages have boxes that indicate out of date information (often indicating which release they were last updated for)
      • New functionality probably merits new pages, the Wiki was created for original Cumulus, and not based around MX functionality
  • Extra Sensors
Someone needs to write a page explaining how Cumulus 1 handles Extra sensors
MX releases have been refining handling of sensors. Can you write a page explaining how the handling has changed for different MX builds.