I’ve created a new wiki for ‘community’ documentation for the SSP.
you can find it here: https://github.com/TheTechnobear/SSP/wiki
- module documentation, both factory and 3rd party
- general ssp information
- development information
- tips n’ tricks
It should be stressed this is design to supplement this forum, not in any way replace it!
as part of this, you will notice I have already been including links back to this forum to appropriate topics.
e.g. if there is a module page here already, I link back to it.
generally, what Id like to do is make sure that I have the appproriate information in the wiki, but link back to ‘discussions’ are on this forum.
- One place for my module documentation
this started because I (thetechnobear) needed somewhere to store documentation for my modules, as Ive found it a pain the way Im doing it currently.
so the structure, Im heading for its. the wiki for documentation and a topic on this forum for discussion.
- community editing
I wanted somewhere that anyone can edit the documentation easily.
my hope is others can contribute to it slowly over time, rather than having to sit down in one sitting for hours to create everything in one go
- Ease of use
Im using GitHub, which features a pretty nice wysiwyg editor that runs in your browser, so you don’t need any software or knowledge of ‘markdown’ languages (though, I do use a bit to make it tidier)
- Open source
Github is full open, so anyone can fork/clone this wiki (its a git repo) , so it is NOT bound to ME. everything that is contributed can be freely downloaded , this also means it could potentially be moved to another wiki provider, should we decide this is needed later.
I’ve pre-populated it with what was available, but its only a start many things need to be added.
Im also working through the factory modules adding parameters, inputs and outputs.
for modules in particular we should develop a ‘style’, so that its easy for users to find things…
I’ll put my suggestions below, but we can work on it together.
PLEASE get involved, if we all spent a little time just documenting one or two modules, we would have them all done really quickly !
BUT if you wait for someone else to do it, then it might never get done,
as for me, I will do some work on it (I’ve already put in a couple of hours!) , but bare in mind, Im also doing SSP module development, so I don’t really want to spend all my SSP time doing this !
also don’t let ‘perfection be the enemy of good enough’ ,
the point about wiki, is it can be edited and improved over time… so get started as soon as possible.
simply go to the above link, and you should see the EDIT button in top corner
it may be you need a GitHub account (its free) and be logged in.
there are tutorials online on how to use, but if anyone has any tips - please share on this topic
for now, you might want to look at a couple of pages Ive already created (e.g SVF, home page)
this show how to :
- add external links (e.g. to webpage)
- use tables for structuring
- link/create new wiki pages with titles
Ive also created a topic with some tips in the wiki on the contributing page
please use this topic for discussions about how to use this wiki, things like style… or to help newcomers get starting on contributing.