Skip to content

/heritrix3

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.

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

Documentation update for 3.4.0-YYYYMMDD releases #233

Open
anjackson opened this Issue Feb 19, 2019 · 5 comments

Comments

Assignees

@anjackson anjackson

Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@anjackson @ruebot
@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

This comment has been minimized.

Sign in to view
Copy link
Collaborator Author

anjackson commented Feb 26, 2019

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

@ruebot ruebot referenced this issue Mar 5, 2019

Merged

Add CHANGELOG; address #233. #238

anjackson added a commit that referenced this issue Apr 17, 2019

@anjackson
Merge pull request #238 from ruebot/issue-233 
Add CHANGELOG; address #233.
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
8492306
@anjackson

This comment has been minimized.

Sign in to view
Copy link
Collaborator Author

anjackson commented Apr 17, 2019

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

This comment has been minimized.

Sign in to view
Copy link
Collaborator Author

anjackson commented Apr 17, 2019

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

This comment has been minimized.

Sign in to view
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

This comment has been minimized.

Sign in to view
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! 😃
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.