heritrix3 icon indicating copy to clipboard operation
heritrix3 copied to clipboard

Published 20 hours ago • verified publisher icon internetarchive

Documentation update for 3.4.0-YYYYMMDD releases

Open anjackson opened this issue 6 years ago • 5 comments

We should clean up some of the more problematic documentation issues.

  • [x] The release notes are a bit of a mess (only found via the wiki index). Should we move them into a CHANGES.md file? Can we also pull in @kris-sigur blogs 1, 2 and get all the way back to the Cookie Monster?
  • [ ] The major 'front pages' should be reviewed to check they make basic sense and link to the right places.

anjackson avatar Feb 19 '19 16:02 anjackson

And @ruebot makes this suggestion, which LGTM I think: https://gist.github.com/ruebot/f2c0493bb205ba2db9ef0363ff8d7e50

anjackson avatar Feb 26 '19 22:02 anjackson

I think we should go ahead with your changelog proposal. Did you notice any major problems with the README or wiki?

anjackson avatar Apr 17 '19 21:04 anjackson

n.b. added change log generation to https://github.com/internetarchive/heritrix3/wiki/HOWTO-Ship-a-Heritrix-Release

anjackson avatar Apr 17 '19 21:04 anjackson

@anjackson hopefully I'll get back to reviewing the documentation soon. I shared this work-in-progress on a oh-sos call a couple weeks ago. I think you were on holiday.

ruebot avatar Apr 18 '19 02:04 ruebot

The major 'front pages' should be reviewed to check they make basic sense and link to the right places.

Let me see if I can come up with a draft PR for the README on Monday. I'll even add it to my todo app! :smiley:

ruebot avatar Apr 18 '19 02:04 ruebot