Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation update for 3.4.0-YYYYMMDD releases #233

Open
1 of 2 tasks
anjackson opened this issue Feb 19, 2019 · 5 comments
Open
1 of 2 tasks

Documentation update for 3.4.0-YYYYMMDD releases #233

anjackson opened this issue Feb 19, 2019 · 5 comments
Assignees
@anjackson

Comments

@anjackson
Copy link
Collaborator

anjackson commented Feb 19, 2019 •
edited

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

  • 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 anjackson self-assigned this Feb 19, 2019
@anjackson anjackson changed the title Documentation update for 3.4.0-YYYYMMDD Documentation update for 3.4.0-YYYYMMDD releases Feb 19, 2019
@anjackson
Copy link
Collaborator Author

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

@ruebot ruebot mentioned this issue Mar 5, 2019
Merged
anjackson added a commit that referenced this issue Apr 17, 2019
@anjackson
Merge pull request #238 from ruebot/issue-233
8492306 
Add CHANGELOG; address #233.
@anjackson
Copy link
Collaborator Author

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

@anjackson
Copy link
Collaborator Author

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

@ruebot
Copy link
Collaborator

ruebot commented Apr 18, 2019

@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
Copy link
Collaborator

ruebot commented Apr 18, 2019

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! 😃

@ruebot ruebot mentioned this issue Apr 22, 2019
Merged
nlevitt added a commit that referenced this issue May 3, 2019
@nlevitt
Merge branch 'ydl' into ait-qa
aec1443 
* ydl:
  whoops, better spawn the thread first
  read stderr and stdout in separate threads...
  do not drop any `CrawlURI.data` between processing
  nothing private ever
  quiet org.mortbay.log (jetty?) logging
  making everything work
  ExtractorYoutubeDL
  Update changelog for 3.4.0-20190418
  [maven-release-plugin] prepare for next development iteration
  [maven-release-plugin] prepare release 3.4.0-20190418
  set of frontier management changes to support CrawlHQ module
  Remove suffix from warcWriter since it is no longer used.
  Add CHANGELOG; address #233.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@anjackson anjackson

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@anjackson @ruebot