{"action":"created","issue":{"url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/issues/11344","labels_url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/issues/11344/labels{/name}","comments_url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/issues/11344/comments","events_url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/issues/11344/events","html_url":"https://github.com/GoogleCloudPlatform/kubernetes/issues/11344","id":95311979,"number":11344,"title":"Implement the steps necessary for publishing docs to gh-pages (out of master)","user":{"login":"RichieEscarez","id":11762685,"avatar_url":"https://avatars.githubusercontent.com/u/11762685?v=3","gravatar_id":"","url":"https://api.github.com/users/RichieEscarez","html_url":"https://github.com/RichieEscarez","followers_url":"https://api.github.com/users/RichieEscarez/followers","following_url":"https://api.github.com/users/RichieEscarez/following{/other_user}","gists_url":"https://api.github.com/users/RichieEscarez/gists{/gist_id}","starred_url":"https://api.github.com/users/RichieEscarez/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/RichieEscarez/subscriptions","organizations_url":"https://api.github.com/users/RichieEscarez/orgs","repos_url":"https://api.github.com/users/RichieEscarez/repos","events_url":"https://api.github.com/users/RichieEscarez/events{/privacy}","received_events_url":"https://api.github.com/users/RichieEscarez/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/labels/kind/documentation","name":"kind/documentation","color":"c7def8"},{"url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/labels/priority/P1","name":"priority/P1","color":"eb6420"},{"url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/labels/team/UX","name":"team/UX","color":"d2b48c"}],"state":"open","locked":false,"assignee":{"login":"krousey","id":157083,"avatar_url":"https://avatars.githubusercontent.com/u/157083?v=3","gravatar_id":"","url":"https://api.github.com/users/krousey","html_url":"https://github.com/krousey","followers_url":"https://api.github.com/users/krousey/followers","following_url":"https://api.github.com/users/krousey/following{/other_user}","gists_url":"https://api.github.com/users/krousey/gists{/gist_id}","starred_url":"https://api.github.com/users/krousey/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/krousey/subscriptions","organizations_url":"https://api.github.com/users/krousey/orgs","repos_url":"https://api.github.com/users/krousey/repos","events_url":"https://api.github.com/users/krousey/events{/privacy}","received_events_url":"https://api.github.com/users/krousey/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/milestones/6","html_url":"https://github.com/GoogleCloudPlatform/kubernetes/milestones/v1.0","labels_url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/milestones/6/labels","id":969317,"number":6,"title":"v1.0","description":"Issues that need to be resolved for v1.0 of Kubernetes.","creator":{"login":"goltermann","id":9358478,"avatar_url":"https://avatars.githubusercontent.com/u/9358478?v=3","gravatar_id":"","url":"https://api.github.com/users/goltermann","html_url":"https://github.com/goltermann","followers_url":"https://api.github.com/users/goltermann/followers","following_url":"https://api.github.com/users/goltermann/following{/other_user}","gists_url":"https://api.github.com/users/goltermann/gists{/gist_id}","starred_url":"https://api.github.com/users/goltermann/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/goltermann/subscriptions","organizations_url":"https://api.github.com/users/goltermann/orgs","repos_url":"https://api.github.com/users/goltermann/repos","events_url":"https://api.github.com/users/goltermann/events{/privacy}","received_events_url":"https://api.github.com/users/goltermann/received_events","type":"User","site_admin":false},"open_issues":49,"closed_issues":740,"state":"open","created_at":"2015-02-06T20:27:16Z","updated_at":"2015-07-17T00:04:14Z","due_on":null,"closed_at":null},"comments":11,"created_at":"2015-07-15T23:32:16Z","updated_at":"2015-07-17T00:12:58Z","closed_at":null,"body":"As part of the release process, we need to process our .md files, specifically our user-facing documentation under the \"docs\" and \"examples\" folders in the master branch, and then copy them over to a release specific folder in the gh-pages (for example, the v1.0 folder is \"v1_0\" and the corresponding HEAD folder is \"vHEAD\".\r\n\r\nThe gh-pages directory structure will be match master with the exception that there will be a version specific container folder at gh-pages root. For v1.0, we need to copy all files into the 'v1_0' and 'vHEAD' folders.\r\n\r\nView my fork(WIP) for the current test build: [http://richieescarez.github.io/kubernetes/v1_0/index.html](http://richieescarez.github.io/kubernetes/v1_0/index.html) *(note that ive manually fixed the .md files to get this staging site to work so it contains many broken links and missing files (ie. files in subdirectories of \"docs\" and all of vHEAD is missing))*\r\n\r\nFor V1.0, we will utilize the GitHub Pages build (which is a Jekyll build) and to do so, we need the following in order to deliver for v1.0 GA:\r\n\r\n(1)\r\nEvery file file requires front matter (in every .md file - *for GitHub Pages/Jekyll build to recognize and process the file*). The layout we will use will be located here: gh-pages root > _layouts > [docwithnav.html](https://github.com/RichieEscarez/kubernetes/blob/gh-pages/_layouts/docwithnav.html).\r\n\r\nTo use that layout for each of our .md files, we need to run a script to insert the \"docwithnav\" attribute to the top (line1) of each file:\r\n\r\n     ---\r\n     layout: docwithnav\r\n     ---\r\n(*[view example here](https://github.com/RichieEscarez/kubernetes/tree/gh-pages/v1_0)*)\r\n\r\n(2)\r\nAll the links in each of the .md files, must be process to replace pointers to *.md with *.html. (issue: https://github.com/github/pages-gem/issues/69)\r\n\r\nThis should cover all types of relative, anchor, and markdown style links (and not affect any external URLs). In order to keep links between files working, we should continue to use relative links so that files only link to those that correspond to that release version (within the same folder in gh-pages root).\r\n\r\nAlternatively, we can hard code in the absolute urls and version's folder using `{{ site.url }}`/*vFolderVersion*/*relative_link_here.html.\r\n\r\nExamples:  \r\nLinks like (but not limited to):\r\n\r\n    `[link text](../filename.md)`\r\n - [example](https://raw.githubusercontent.com/RichieEscarez/kubernetes/gh-pages/vHEAD/index.md)\r\n\r\n   `[Getting Started Guides](docs/getting-started-guides)`\r\n - [example](https://raw.githubusercontent.com/RichieEscarez/kubernetes/gh-pages/v1_0/README.md)\r\n\r\nMust be changed to:\r\n\r\n   `[link text](../filename.html)`\r\n\r\n   `[Getting Started Guides](docs/getting-started-guides/README.html)`\r\n\r\n(3)\r\nOnce the .md files are processed (front matter added and links fixed), then in order for us to be able to publish on kubernetes.io, we must copy those processed .md files into the corresponding folders in gh-pages (for v1.0, thats the 'v1_0' folder). "},"comment":{"url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/issues/comments/122134951","html_url":"https://github.com/GoogleCloudPlatform/kubernetes/issues/11344#issuecomment-122134951","issue_url":"https://api.github.com/repos/GoogleCloudPlatform/kubernetes/issues/11344","id":122134951,"user":{"login":"bgrant0607","id":7725777,"avatar_url":"https://avatars.githubusercontent.com/u/7725777?v=3","gravatar_id":"","url":"https://api.github.com/users/bgrant0607","html_url":"https://github.com/bgrant0607","followers_url":"https://api.github.com/users/bgrant0607/followers","following_url":"https://api.github.com/users/bgrant0607/following{/other_user}","gists_url":"https://api.github.com/users/bgrant0607/gists{/gist_id}","starred_url":"https://api.github.com/users/bgrant0607/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bgrant0607/subscriptions","organizations_url":"https://api.github.com/users/bgrant0607/orgs","repos_url":"https://api.github.com/users/bgrant0607/repos","events_url":"https://api.github.com/users/bgrant0607/events{/privacy}","received_events_url":"https://api.github.com/users/bgrant0607/received_events","type":"User","site_admin":false},"created_at":"2015-07-17T00:12:58Z","updated_at":"2015-07-17T00:12:58Z","body":"Issues reported by @thockin:\r\n\r\n* markdown #### turns into centered HTML\r\n* markdown ```yaml leaves the word yaml"}}