On 10/09/16 02:00, Jan Kandziora wrote: > Am 08.09.2016 um 22:32 schrieb Johan Ström: >> .. what else? >> > First: I'd love to get rid of are these personal blogs who give stray > information bites which are quickly outdated and totally out of control. > This is the source of most misfortune for owfs users. I'm pretty sure > only 1 of 10 shows up here at the mailing list and ask us. Nine of ten > people will give up or just live with their brittle setup. > > ... +1 to all of what you wrote there (including the bits i ...'ed away). > >> Jan, your last lines talked about alternative to push/pull content. A >> github hosted page could actually be edited directly in the github UI, >> there is a Edit button which opens an editor directly. You'd of course >> have to fork it first, and you still need to do basic markup. >> But if instructed how to do it, is that too advanced? >> > Not too advanced. > > My concern was: For end users, the biggest hurdle would be additional > software. They usually don't care about the markup, we have to fix that. > > We need to have a documentation project where end users can easily edit > pages and we have bit of control about what is written there, so > outdated and wrong information cannot live forever. That's why I want to > encourage end users to document their owfs related stuff at a central > site. So we can maintain it. So basically, the main website is something *we* should maintain and not something random contributors add content to. If that is the case, I don't see a problem in using a local editor, and push changes using git. If we go with Jekyll & GH pages, you don't need anything but a text editor and git, at least not for writing basic content. When we/someone first develops the basic structure and templates it might be beneficial so you can see the end-result directly. But for just editing content, any editor could do. If you want a rendered view of the content, any editor with a Markdown preview would work. > This should be seperated from "official" documentation but in a way the > difference is only sublime. So people see "Hey, my owfs project is > recognized by the owfs people. Great!" Yep, good to integrate it and make it part of official, encourages writers. > So, having two wikis, one along the official sources and one for end > users would be great. > I think we can push wiki pages created from manpages etc. so this will > make Colin and Stefano happy too, I think. Groff can (or so says google) write HTML files from manpages, so shouldn't be an issue to automate. > Okay? Can we settle on this? Or continue discussion? I give thumbs up to having two spaces (official + user contributed).
---- 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. This is at least a simple start which doesn't require any work on hosting etc, and we can get started pretty much right away. As you wrote before, there isn't time in life to make everything perfect, at least not from day 1 :) In addition, we make an effort to move the SF git repo to Github. We could use an existing SF->github issue importer script, if we want to keep the issues history. But that does not support tracking users etc, and since there are quite few issues, we might just skip it? I've written to Paul & Mike asking for a public acknowledge from Paul that we do this, that we use the content on the existing site, and for login details for the current site. Hopefully we hear from them soon! Regards Johan ------------------------------------------------------------------------------ _______________________________________________ Owfs-developers mailing list Owfs-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/owfs-developers
