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.

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

Reformatting and cleanup of the releases page #149

Closed
5 of 6 tasks
E3V3A opened this issue Oct 12, 2014 · 16 comments
Closed
5 of 6 tasks

Reformatting and cleanup of the releases page #149

E3V3A opened this issue Oct 12, 2014 · 16 comments

Comments

@E3V3A
Copy link
Contributor

E3V3A commented Oct 12, 2014

I propose that we start thinking about how to make a more clean Releases page. It's growing out of control and contain a huge bunch of redundant info. I suggest we start by fixing some of these:

  • Remove the "WIP -- WIP -- ..." lines.
  • Remove or move the "Disclaimer Acceptance..." info
  • Remove or move the "Installation Instructions" info
  • Remove or move the "Bug Report..." info
  • Perhaps putting all detailed change-log into a text file, including a list of commit hash codes.
  • Consider making a "Table of Contents" table with one release per line, with short description and MD5 check-sum. Perhaps something like this:
Version Build MD5 Short Description
0.1.23 b0 ab5270971de92655846108f2b4b77646 Added: AT,PSC and some code cleanup
0.1.22 b0 6d8de90cd8a739a4d5783b5738b9ca44 blah blah

To Developers: Feedback please!

@SecUpwN
Copy link
Member

SecUpwN commented Oct 12, 2014

Ok, that sounds like a plan - let me do this, please. I have it on my list now, please give me time until next sunday since I'm gone for another week. Thank you very much, @E3V3A.

@SecUpwN
Copy link
Member

SecUpwN commented Oct 19, 2014

@E3V3A, I have edited the latest WIP-Release. Would you please check if you like the layout? What else to change? When you like it, I will continue to modify all the other 21 Releases that everyone can see on that page. Maybe it would help if you could link a cool release page you like of another project (e.g. k9)?

Also, shall we continue to use SHA-1 checksums, or shall we use a much more secure checksum?

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 19, 2014

There is no reason to use SHA-1. Check sum is just to check that what you've downloaded has been downloaded properly. As a measure for code integrity it is only of limited use.

Releases: We could just add another/new page, so we don't end up with one HUGE page. Or let's say, one page with the latest 3 releases and all other on another huge page...

@SecUpwN
Copy link
Member

SecUpwN commented Oct 19, 2014

@E3V3A, I would like to avoid having multiple pages. That just doubles the amount of work. I like when everything is in one neat place. What do you think of the changes I did to Release 23? Trust me, when all Releases are cleaned up, we'll have a much nicer Release page and noone will complain. 😺

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 19, 2014

ok. Sure look much better, but get rid of SHA-1 or MD5 for now.

@SecUpwN
Copy link
Member

SecUpwN commented Oct 19, 2014

Ok, erased SHA-1 (which I previously carefully implemented through downloading each damn Release again). Oh well. Next thing up: I could make our Release-Page even neater if I put the stuff from The Version changes into our real CHANGELOG. Is that a neat solution which skips the "table of contents"?

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 19, 2014

I hope you backed it up... ; )

@SecUpwN
Copy link
Member

SecUpwN commented Oct 19, 2014

Dude, are you kidding me? 👅 What should I have backed up, @E3V3A?

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 19, 2014

Don't worry, but why did you cross of ToC if you didn't add it?

@SecUpwN
Copy link
Member

SecUpwN commented Oct 19, 2014

Because I thought we could skip that step when I put the stuff that changed from the Release-Page into our CHANGELOG.md and easily link to it in the Release-Notes. But of course, I can create a "Shortlog" as well, which just puts much more burden on our back. All that shit screams to be maintained, you know?

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 19, 2014

ok, so leave it for now. I'll have a look at it some other day, and perhaps I can run some regex magic on it to whip up a table in a few strokes...

@SecUpwN
Copy link
Member

SecUpwN commented Oct 19, 2014

Shall I link the changes to our CHANGELOG.md? It would make the Release-Page much smaller.

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 20, 2014

Yes, that's what I thought.

@SecUpwN
Copy link
Member

SecUpwN commented Oct 20, 2014

@tobykurien since you are currently our main developer, please tell me if you'd really like to see a "Shortlog" as prposed in the OP or if I can continue to maintain the already existing Changelog. @E3V3A, I've been sitting all day to re-craft our WIP-Releases and our CHANGELOG. Would you please give me some feedback on both? What else can I do to improve user experience on our GitHub?

@tobykurien
Copy link
Contributor

I am happy with the changelog and releases page as they currently are :)

@E3V3A
Copy link
Contributor Author

E3V3A commented Oct 20, 2014

That look great! Now it look very professional. Thanks!

@E3V3A E3V3A closed this as completed Oct 20, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants