I've found one more reason to have a separate owfs-doc repository: images. Since the wiki itself has no (simple) means of hosting images, you have to upload them somewhere else, for example the git repo. Now, the downside is: you cannot have fully public repos.. You would thus have to be given write access, or use pull requests, to upload images. A bit more work than just uploading a file, but can be done in the GH Web UI.
In action: https://github.com/owfs/owfs-doc/ has an image commited in the repo (uploaded using the "Upload File" feature in the UI, which also supports uploading through pull request). https://github.com/owfs/owfs-doc/wiki references that image. Colin, Jan, Colin, and everyone else: Besides the above, what do you guys think of the GitHub wiki? Would it be an acceptable way to go forward? It certainly has a few downsides (mainly lack of structuring, image uploads), but it's very easy to get started, and no external hosting required. I think I would vote to focus on a single wiki to start with, and nothing on GH pages besides perhaps welcome-page, very basic info and pointers to the wiki.. That way we can start to build up all the info on the wiki, and when we have some nice wiki-pages, we could move it to GH pages ("the homepage") if we think it makes sense. Regards Johan On 11/09/16 23:08, Mick Sulley wrote: > OK the examples look OK, I don't know how to do it but if this is our > final solution I will invest the time to find out. > > > On 11/09/16 21:50, Johan Ström wrote: >> On 11/09/16 22:39, Mick Sulley wrote: >> >>> I just added a new page and it seems pretty easy to me to do that, but I >>> don't see any way to create a page hierarchy, is that possible? I think >>> we would need to group information to make it easily accessible. >>> >>> btw I think this discussion is a fantastic move in the right direction, >>> currently we have great software with poor documentation. >>> >>> Mick >>> >>> >> Afaik the GH wiki system lacks proper hierarchy system, at least an >> automated one. >> It is however possible to build custom sidebars with "structure", but it >> must be written manually (although once you set some basic main pages, >> it won't change much). >> >> Github has a page where they have "good examples" of wikis: >> >> https://github.com/showcases/projects-with-great-wikis >> >> ------------------------------------------------------------------------------ >> _______________________________________________ >> Owfs-developers mailing list >> Owfs-developers@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/owfs-developers > > ------------------------------------------------------------------------------ > _______________________________________________ > Owfs-developers mailing list > Owfs-developers@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/owfs-developers ------------------------------------------------------------------------------ _______________________________________________ Owfs-developers mailing list Owfs-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/owfs-developers
