{"action":"created","issue":{"url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/issues/159","repository_url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common","labels_url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/issues/159/labels{/name}","comments_url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/issues/159/comments","events_url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/issues/159/events","html_url":"https://github.com/GoogleCloudPlatform/gcloud-common/issues/159","id":169692137,"number":159,"title":"Individual Package Documentation Proposal","user":{"login":"blowmage","id":730,"avatar_url":"https://avatars.githubusercontent.com/u/730?v=3","gravatar_id":"","url":"https://api.github.com/users/blowmage","html_url":"https://github.com/blowmage","followers_url":"https://api.github.com/users/blowmage/followers","following_url":"https://api.github.com/users/blowmage/following{/other_user}","gists_url":"https://api.github.com/users/blowmage/gists{/gist_id}","starred_url":"https://api.github.com/users/blowmage/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/blowmage/subscriptions","organizations_url":"https://api.github.com/users/blowmage/orgs","repos_url":"https://api.github.com/users/blowmage/repos","events_url":"https://api.github.com/users/blowmage/events{/privacy}","received_events_url":"https://api.github.com/users/blowmage/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/labels/docs","name":"docs","color":"ededed"},{"url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/labels/site","name":"site","color":"207de5"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-08-05T20:41:17Z","updated_at":"2016-08-05T20:46:32Z","closed_at":null,"body":"This week the gcloud-ruby repo switched from a monolithic package to individual packages. This move is a pretty radical change, and I think a similar change can be made in the angular application to support it. I understand and respect the desire to change the angular application in an interative and step-wise manner, but I have some reservations about the direction it is now going and the \"bundled\" package concept.\r\n\r\nI figured I would attempt to describe some of the ideas I had about what a non-monolithic documentation site could offer. I started down this line of thinking when I saw one of the earliest mockups for the new site. It seemed to me that the existing side navigation and the package switcher served the same purpose, and would ultimately be confusing to users.\r\n\r\n![google-cloud-mockup-annotated](https://cloud.githubusercontent.com/assets/730/17449359/2f8b1012-5b17-11e6-9a10-f601e2d77796.jpg)\r\n\r\nWhat if these two concepts were merged? What if the documentation were bundled not by duplicating documentation in different packages? But by making the angular application aware of multiple packages? What if it allowed users to select different versions of each package? v0.20.0 of Datastore along side v0.13.0 of BigQuery? What if it looked like this?\r\n\r\n![google cloud overview](https://cloud.githubusercontent.com/assets/730/17449390/5f7551f2-5b17-11e6-8552-876a2c2d69f1.png)\r\n\r\nClicking on a package would open the packages TOC navigation. In this version of the BigQuery package we added the `Schema` class to the package and TOC. Previous versions maintain their own TOC.\r\n\r\n![bigquery overview](https://cloud.githubusercontent.com/assets/730/17449440/b8960e70-5b17-11e6-9496-475a39f936ea.png)\r\n\r\nClicking a package's version would open a menu, so the user could view a specific version. We can also label each version as either the latest release or a previous release.\r\n\r\n![bigquery chooser](https://cloud.githubusercontent.com/assets/730/17449455/e039da6a-5b17-11e6-8cd5-2dfbc85aab17.png)\r\n\r\nViewing an older version will display that version's TOC. Notice that `Schema` is not listed, as this version of the library did not have it.\r\n\r\n![bigquery v0 13 0 overview](https://cloud.githubusercontent.com/assets/730/17449508/47349d68-5b18-11e6-9e1b-61c9816e8922.png)\r\n\r\nBecause the angular application is aware of different packages and their respective versions, it can aid the user as they try to navigate them. One way is to prompt the user to change versions when looking for a structure that does not exist in the version they are in.\r\n\r\n![bigquery v0 13 0 404](https://cloud.githubusercontent.com/assets/730/17449540/7c8aa5d4-5b18-11e6-963e-f3b36c6babf3.png)\r\n\r\nMy intention is to help lay out a vision. I think we have a great opportunity to really help users find information in a way that supports the move to individual packages. Hopefully this proposal helps by presenting some ideas not considered before, or prompts even newer ideas in others."},"comment":{"url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/issues/comments/237961392","html_url":"https://github.com/GoogleCloudPlatform/gcloud-common/issues/159#issuecomment-237961392","issue_url":"https://api.github.com/repos/GoogleCloudPlatform/gcloud-common/issues/159","id":237961392,"user":{"login":"callmehiphop","id":1707267,"avatar_url":"https://avatars.githubusercontent.com/u/1707267?v=3","gravatar_id":"","url":"https://api.github.com/users/callmehiphop","html_url":"https://github.com/callmehiphop","followers_url":"https://api.github.com/users/callmehiphop/followers","following_url":"https://api.github.com/users/callmehiphop/following{/other_user}","gists_url":"https://api.github.com/users/callmehiphop/gists{/gist_id}","starred_url":"https://api.github.com/users/callmehiphop/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/callmehiphop/subscriptions","organizations_url":"https://api.github.com/users/callmehiphop/orgs","repos_url":"https://api.github.com/users/callmehiphop/repos","events_url":"https://api.github.com/users/callmehiphop/events{/privacy}","received_events_url":"https://api.github.com/users/callmehiphop/received_events","type":"User","site_admin":false},"created_at":"2016-08-05T20:46:32Z","updated_at":"2016-08-05T20:46:32Z","body":"So my understanding is that we create a version dropdown for every module and when the `Google Cloud` version is changed, then all the individual service versions change to what is available within that umbrella package. Does that sound right?"}}
{"actor":{"display_login":"callmehiphop"}}