← Back to team overview

holland-discuss team mailing list archive

Re: Online Documentation Updates?

 

Agreed the docs could definitely use some layout changes. The fact that I had an issue trying to find a feature I knew existed is a good indicator of the average-minded somewhat unobservant folks that could end up using Holland such as myself :)

Getting rid of the providers, hmm...the concept was never well explained in the documentation or otherwise so yes is probably is due for an update. From an end user standpoint, simply having, say, "default" backup configs in which user defined backup-sets inherit from would make things more clear. That's how it works now (unless it's been changed recently?) anyway and explaining it that way to the end user is perhaps more effective. Even going as far as to change the structure of /etc/holland at some point in a future branch.

On Apr 2, 2013, at 12:37 PM, Andrew Garner wrote:

> Yeah, the copyright needs updated - this should probably be baked in the version bump script.  There was a bug in the version_bump script in bumping the documentation version number that I just fixed recently and I haven't pushed the documentation since.   Feel free to send any more additional pull requests for this kind of stuff - I am really happy to merge it.
> 
> Honestly, I think the documentation needs a serious revamp.  The flow needs some work and there aren't really any examples.   Probably some discussion on "selecting a backup strategy" would be useful too, along with commentary on the individual backup strategy plugins.  I often find myself wanting to link to specific options under a particular plugin's documentation, but we'll need to update the layout to add that feature.
> 
> I think we should drop the phrase "provider" as it is not very descriptive as well.  I've also been moving away from the term "backup framework" to "backup manager", as holland is really more of a end-user tool.  I think its clear that v1.0 is very bad from a developer standpoint for extending :(   Although v1.1+ has cleaned that up significantly, it currently lacks useful documentation here and v1.1 has obviously stalled out.
> 
> ~Andy
> 
> 
> On Tue, Apr 2, 2013 at 10:11 AM, Tim Soderstrom <tim@xxxxxxxxxxxxxxxxxxxxx> wrote:
> Aha found what I was looking for after building the docs locally. The documentation on docs.hollandbackup.org is current, though the copyright is out of date and there isn't any easily found version information. Perhaps we should consider adding it? The old 1.0.6 documentation listed a version number in a sub-header.
> 
> On Apr 2, 2013, at 8:59 AM, Tim Soderstrom wrote:
> 
> > Howdy Folks!
> >
> > I noticed docs.hollandbackup.org appears to be out of date in places and I suspect it's still using 1.0.6 documentation? What I was actually thinking is having documentation from multiple versions online and, on the blog, having a drop-down to select which one you want or something like that. 1.0.6 is likely still used in many places. I know the docs stuff is now in daCloudd so wasn't sure how to update it on my end.
> >
> > Along a similar vein, the blog probably should have a 1.0.8 announcement of sorts. I can author a post for that and just put in pull request for those updates.
> >
> > Finally, I have setup 1.0.8 on a 10.04 instance doing some local and remote backups (though only using mysqldump) and seems to work like a champ! The docs issue came to be because I couldn't remember if 1.0.8 had post backup options and what those options were (I'd like to ship backups to an external server for instance) so, assuming that made it to 1.0.8, I'll give those a nice test as well.
> >
> > Werd!
> >
> > Sweetums
> > _______________________________________________
> > Mailing list: https://launchpad.net/~holland-discuss
> > Post to     : holland-discuss@xxxxxxxxxxxxxxxxxxx
> > Unsubscribe : https://launchpad.net/~holland-discuss
> > More help   : https://help.launchpad.net/ListHelp
> >
> 
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~holland-discuss
> Post to     : holland-discuss@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~holland-discuss
> More help   : https://help.launchpad.net/ListHelp
> 


References