openpreserve / jhove

File validation and characterisation.
http://jhove.openpreservation.org
Other
171 stars 79 forks source link

Review JHOVE for beginners guide #124

Open ghost opened 8 years ago

ghost commented 8 years ago

Address outstanding comments and add further information to the new JHOVE user guide: https://drive.google.com/open?id=1or8P5hI_BChnc1itr0KV2qOCZfdyBtRX6QMT0ucJzvU

carlwilson commented 7 years ago

I've made a start adding this to the GitHub pages site here: https://github.com/openpreserve/jhove/tree/gh-pages/getting-started/beginners which can be seen online here: http://jhove.openpreservation.org/getting-started/beginners/. I've also been busy preparing screenshots. For the next hack day I'd like to discuss the structure, one large page doesn't feel like the best solution, and work on converting the rest of the document.

gmcgath commented 7 years ago

What's the overall intent? Currently it looks like a quickstart guide, for getting JHOVE installed and running. If that's the aim, a single page sounds very reasonable. If this is a start toward a more comprehensive document, explaining how to do typical tasks with JHOVE, then an outline for discussion would be a good next step. Personally, I think the bigger document would be a good idea, and I'd be willing to help out on it.

carlwilson commented 7 years ago

Hi, Gary, bigger and comprehensive is the idea and there is some source material (a google doc) and I've been preparing screenshots. Your help would be appreciated :+1:

gmcgath commented 7 years ago

Some thoughts for the online hack day:

I'll compare the Mac instructions with the way it works on Yosemite 10.10.5 (which is what I already have) and note any differences. I may also be able to look into Linux installation instructions.

The Google doc currently has nothing on using JHOVE from the command line. I can make a start at that.

There should also be something on the config file.

carlwilson commented 7 years ago

Hi @gmcgath I think that command line and config instructions would be really useful :+1:

ross-spencer commented 7 years ago

Hi Both,

A colleague (Fran) is looking at the guide from an absolute beginners perspective here at Archives NZ. I'll attach results as they go.

Ross

carlwilson commented 7 years ago

Thanks @ross-spencer I'm retiring to bed soon but will check in the morning.

gmcgath commented 7 years ago

A bit of confusion: There's a Google Docs version and a Github Pages version. The Google Docs one is more complete, so I've just added sections on the command line and the config file to it. Am I doing that right, @carlwilson ?

gmcgath commented 7 years ago

I've made some notes on the Mac installation in the Google doc.

MartinSpeller commented 4 years ago

Review JHOVE for beginners guide #124 - Assigned to TBA