{"action":"created","issue":{"url":"https://api.github.com/repos/PowerShell/PowerShell/issues/3636","repository_url":"https://api.github.com/repos/PowerShell/PowerShell","labels_url":"https://api.github.com/repos/PowerShell/PowerShell/issues/3636/labels{/name}","comments_url":"https://api.github.com/repos/PowerShell/PowerShell/issues/3636/comments","events_url":"https://api.github.com/repos/PowerShell/PowerShell/issues/3636/events","html_url":"https://github.com/PowerShell/PowerShell/issues/3636","id":223892413,"number":3636,"title":"Require Docs to Be Available Online","user":{"login":"michaeltlombardi","id":14190564,"avatar_url":"https://avatars1.githubusercontent.com/u/14190564?v=3","gravatar_id":"","url":"https://api.github.com/users/michaeltlombardi","html_url":"https://github.com/michaeltlombardi","followers_url":"https://api.github.com/users/michaeltlombardi/followers","following_url":"https://api.github.com/users/michaeltlombardi/following{/other_user}","gists_url":"https://api.github.com/users/michaeltlombardi/gists{/gist_id}","starred_url":"https://api.github.com/users/michaeltlombardi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/michaeltlombardi/subscriptions","organizations_url":"https://api.github.com/users/michaeltlombardi/orgs","repos_url":"https://api.github.com/users/michaeltlombardi/repos","events_url":"https://api.github.com/users/michaeltlombardi/events{/privacy}","received_events_url":"https://api.github.com/users/michaeltlombardi/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2017-04-24T17:20:29Z","updated_at":"2017-04-24T17:38:03Z","closed_at":null,"body":"## Expected Behavior\r\nWhen using PowerShell of any version, I should be able to review published online documentation for the version of PowerShell I am using in an easily discoverable location.\r\n\r\n## Current Behavior\r\nDocumentation exists online in properly published formats for PowerShell versions `5.1` and below.\r\nCurrently, the documentation for `6.x` lives only in the markdown documents of the repository and is not published outside of this.\r\n\r\n## Possible Solution\r\nPublish the documentation, but be clear that `6.x` is not released yet (as currently done in the docs inside the repo).\r\n\r\n## Context\r\nA naive user of PowerShell, particularly cross-platform PowerShell v6, may not necessarily know to go check the repository for documentation. Moreover, if the docs are not easily discoverable from a google search of \"PowerShell Docs version 6\" or similar, they may as well not exist for a segment of the user base.\r\n\r\nPublishing the documentation makes it easier for folks to dive into the documents and to provide feedback/actually use the documents in testing scenarios. Of course, avoiding a conflict with the documentation for released PowerShell versions is a concern, but being clear and up front about v6's state in the docs will help with this."},"comment":{"url":"https://api.github.com/repos/PowerShell/PowerShell/issues/comments/296763183","html_url":"https://github.com/PowerShell/PowerShell/issues/3636#issuecomment-296763183","issue_url":"https://api.github.com/repos/PowerShell/PowerShell/issues/3636","id":296763183,"user":{"login":"zjalexander","id":6953993,"avatar_url":"https://avatars2.githubusercontent.com/u/6953993?v=3","gravatar_id":"","url":"https://api.github.com/users/zjalexander","html_url":"https://github.com/zjalexander","followers_url":"https://api.github.com/users/zjalexander/followers","following_url":"https://api.github.com/users/zjalexander/following{/other_user}","gists_url":"https://api.github.com/users/zjalexander/gists{/gist_id}","starred_url":"https://api.github.com/users/zjalexander/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zjalexander/subscriptions","organizations_url":"https://api.github.com/users/zjalexander/orgs","repos_url":"https://api.github.com/users/zjalexander/repos","events_url":"https://api.github.com/users/zjalexander/events{/privacy}","received_events_url":"https://api.github.com/users/zjalexander/received_events","type":"User","site_admin":false},"created_at":"2017-04-24T17:38:03Z","updated_at":"2017-04-24T17:38:03Z","body":"Thanks for posting this - I was hitting the Twitter character limit :)\r\n\r\nThere are several issues here.\r\n\r\n1) PowerShell 6 has [some, but not all, documentation here ](https://github.com/PowerShell/PowerShell-Docs/tree/staging/reference/6). It's a work in progress, as to be expected from an alpha.\r\n\r\n2) PowerShell 6 has [some other documentation here](https://github.com/PowerShell/PowerShell/tree/master/docs) - this is intended to be more specific for a developer audience and not intended to go into the console help.\r\n\r\n3) PowerShell-Docs [does not yet flow into get-help](https://github.com/PowerShell/PowerShell-Docs/issues/1073). This is a known issue and actively being worked on. When the issue is addressed, PowerShell 6 help in the PowerShell-Docs/reference/6 folder will reach the console. "}}
{"actor":{"display_login":"zjalexander"}}