I think a distinctly themed user wiki is probably a good idea. A bunch of the content there will be useful, but not appropriate for docs. Also, other Colin, I can't think of a better way to merge content, e.g. what info I have on the Pi with whatever you're writing, than a wysiwyg editor.
C > On Sep 10, 2016, at 5:54 AM, Colin Law <clan...@gmail.com> wrote: > >> On 10 September 2016 at 11:52, Johan Ström <jo...@stromnet.se> wrote: >>> On 10/09/16 12:13, Colin Law wrote: >>>> On 10 September 2016 at 10:21, Johan Ström <jo...@stromnet.se> wrote: >>>> ... >>>> I suggest the following: >>>> >>>> a) For public site, use Github Pages with Jekyll. >>>> We (the developer community) would use git to push files which are >>>> rendered & published automatically by github on push. >>>> If someone is more confortable with the Github online text editor, that >>>> is possible to. If not a project contributor, you fork first and issue >>>> pull request. >>>> >>>> b) For user-written content, we use a fully open Github Wiki. >>>> If well written articles are put there, we could opt to either copy them >>>> to the site, or at least link them. >>> If I wrote a technical note describing how to interface 1-wire to a Pi >>> which would that go in, and how would a user looking for it know which >>> one to look in? >> Two ways: >> a) You start to write it on the wiki, and if it is a well written >> technical note, the developer community approves it and moves it to the >> site (will probably just be a 1:1 copy of the page), or in some way gets >> featured on the site. > > Moving it would not be a good idea as then there would be broken links > to the original around the internet. > >> b) You write it directly for the site by forking the site, writing the >> note in your own repo, then issue a pull request where we merge your >> changes into the official site. >> Mostly based on what you, the writer, is most comfortable with! >> >> To find user-written content, we first make it very obvious (on the >> site) that we have a wiki with (only) user contributed stuff. If we want >> to make it more integrated, we could add hooks/scripts to automatically >> link any wiki pages directly from the site, thereby making it even >> easier to find. >> (new wiki page => hook called => script adds link to page => deploys new >> page => article is now linked directly from site) >> Might even be possible to show the wiki in an iframe? but probably would >> be too much clutter.. > > That could be a good solution if it worked, so the wiki appears as an > extension to the main site, and everything is indexed and searched > from the main site. Still not sure why an open wiki for everything > would not be good enough and would be simpler to support. > > Colin > > ------------------------------------------------------------------------------ > _______________________________________________ > 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
