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

wiki:astonishing release-cycle.png #29774

Closed
tkivisik opened this issue Jan 16, 2019 · 10 comments
Closed

wiki:astonishing release-cycle.png #29774

tkivisik opened this issue Jan 16, 2019 · 10 comments
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@tkivisik
Copy link
Contributor

tkivisik commented Jan 16, 2019

In the Go Release Cycle wiki page:
https://github.com/golang/go/wiki/Go-Release-Cycle

There is an image representing the Go release cycle. It's astonishing, and I believe it does not have to be.

According to the Principle of Least Astonishment (POLA), a component should behave as most users expect it to. I understand that the current style has nice properties like deduplication (Beta, RC1, Release written once), and it's visually appealing to see a vertical color cut. But, I believe there is no one who often thinks of a year as two halves of a year stacked on top of each other. That means, there is no internal representation like that in our memory. Therefore, we find it hard to remember when exactly the development work starts (the right half), and that defeats the primary purpose of the graph.

However, anyone with an analog clock/watch would have a reference to a cycle with 12 components (the watch dial). Putting Go release cycle on such a dial would reduce astonishment and improve memory for it. Something like this:
https://github.com/tkivisik/less-astonishing/blob/master/go-release-cycle-v1.png

@ianlancetaylor
Copy link
Contributor

Works for me. Thanks. Want to update the wiki page?

@ALTree
Copy link
Member

ALTree commented Jan 16, 2019

In the new design punctual events (like "beta" or "release") are on the wheel with the months and they don't look like events. IMO they should be on the outside, at the end of a radius prolonged outside of the circle.

@tkivisik
Copy link
Contributor Author

tkivisik commented Jan 16, 2019

@ianlancetaylor - Yes, I would like to update the wiki.

@ALTree - How about this version: https://github.com/tkivisik/less-astonishing/blob/master/go-release-cycle-v2.png

@mvdan
Copy link
Member

mvdan commented Jan 17, 2019

I have to agree that the current design is pretty, but confusing. It always takes me a few seconds to figure out what position we're currently in.

My only criticism of the last design is that it seems a bit packed with all that text. Though it's not clear to me how it could be made simpler while keeping most of the information that the old one had.

@tkivisik
Copy link
Contributor Author

tkivisik commented Jan 17, 2019

@mvdan - How about this (larger text size used for time periods, periods moved slightly further away from the Release notes) https://github.com/tkivisik/less-astonishing/blob/master/go-release-cycle-v3.png

@ianlancetaylor - I read that the wiki is maintained by the Go team, and people should not make changes to it directly. Can still do it? Also, the current images is added from images/release-cycle.png, which I don't see anywhere. I could add an image via a link to my repository. Would that be enough?

@bradfitz bradfitz added this to the Unreleased milestone Jan 18, 2019
@bradfitz bradfitz added Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Jan 18, 2019
@tkivisik
Copy link
Contributor Author

@ianlancetaylor @bradfitz - I've made the edit. Let me know if that was ok (I read that the wiki is maintained by the Go team, and people should not make changes to it directly)?

@mvdan
Copy link
Member

mvdan commented Jan 18, 2019

@tkivisik looks good, thanks! Making changes to the wiki directly is fine, as long as any non-trivial changes are discussed first. I'll close this issue as fixed :)

@mvdan mvdan closed this as completed Jan 18, 2019
@tkivisik
Copy link
Contributor Author

@andybons reverted the change due to a file sourced from outside the Golang repository. I don't see a way to fork the wiki repository to make a pull request.

Anyways, the file is uploaded and markdown changed in this branch: https://github.com/tkivisik/gowiki/tree/wiki-update-release-cycle . As it wasn't forked, I'm not sure how to make a pull request to the right wiki repository. Is there a way for me to make that pull request somehow?

@mvdan
Copy link
Member

mvdan commented Jan 19, 2019

Whoops. Reopening to make sure the change is made one way or another.

@andybons do you know how one can upload/add an image to the wiki? I don't see a way to do it, but I'm not experienced with github wikis.

@mvdan mvdan reopened this Jan 19, 2019
@andybons
Copy link
Member

I updated the image. Thanks again @tkivisik and apologies for not noticing this issue existed before I contacted you.

$ git clone git@github.com:golang/go.wiki.git
$ cd go.wiki/images
# change images, commit, and push

zchee pushed a commit to zchee/golang-wiki that referenced this issue Jan 28, 2019
@golang golang locked and limited conversation to collaborators Jan 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

7 participants