{"action":"created","issue":{"url":"https://api.github.com/repos/red-eclipse/world/issues/9","repository_url":"https://api.github.com/repos/red-eclipse/world","labels_url":"https://api.github.com/repos/red-eclipse/world/issues/9/labels{/name}","comments_url":"https://api.github.com/repos/red-eclipse/world/issues/9/comments","events_url":"https://api.github.com/repos/red-eclipse/world/issues/9/events","html_url":"https://github.com/red-eclipse/world/issues/9","id":283500100,"number":9,"title":"Updates regarding the wiki port","user":{"login":"qreeves","id":3297929,"avatar_url":"https://avatars0.githubusercontent.com/u/3297929?v=4","gravatar_id":"","url":"https://api.github.com/users/qreeves","html_url":"https://github.com/qreeves","followers_url":"https://api.github.com/users/qreeves/followers","following_url":"https://api.github.com/users/qreeves/following{/other_user}","gists_url":"https://api.github.com/users/qreeves/gists{/gist_id}","starred_url":"https://api.github.com/users/qreeves/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/qreeves/subscriptions","organizations_url":"https://api.github.com/users/qreeves/orgs","repos_url":"https://api.github.com/users/qreeves/repos","events_url":"https://api.github.com/users/qreeves/events{/privacy}","received_events_url":"https://api.github.com/users/qreeves/received_events","type":"User","site_admin":false},"labels":[{"id":772366934,"url":"https://api.github.com/repos/red-eclipse/world/labels/news","name":"news","color":"28e244","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2017-12-20T09:32:27Z","updated_at":"2017-12-20T14:18:28Z","closed_at":null,"author_association":"OWNER","body":"OK, so we've seen some good work being done on porting the wiki to markdown, but there have been a few teething issues that I now need to address. This is a work in progress, so there may be updates; I'll include a comment when I make changes. This shouldn't be turned into a documentation page until we've solidified the content.\r\n\r\n## The Location\r\nUsing the built-in GitHub wiki doesn't work quite as well as a normal repository, so I'm disabling wikis and moving the existing work to the [Docs Repository](https://github.com/red-eclipse/docs). If you've already check out the existing wiki you should be able to just set the new location and pull from there:\r\n\r\n```\r\ngit remote remove origin\r\ngit remote add origin https://github.com/red-eclipse/docs.git\r\n```\r\n\r\nBy using a normal repository we'll be able to do the proper post-commit actions like IRC channel announcements and automatic deployments to the [Beta Website](http://beta.redeclipse.net).\r\n\r\n## The Style\r\nI didn't set a style guide to begin with because I was unsure of what to expect and unaware of any cross-compatibility issues. As I mentioned, the documentation will be automatically deployed to the Beta Website, and this involves going through a few steps using GitHub Pages. Basically there are two \"pre-processors\", [Jekyll](https://jekyllrb.com/docs/home/), and [Kramdown](https://kramdown.gettalong.org/syntax.html). It is necessary to understand the unique syntax of each when crafting your markdown pages.\r\n\r\n### Headers\r\nAll headers should be presented in ATX format, Setex format is not supported. This means you create headers with the hash symbol (`#`), and not a line followed by a series of dashes (`-`). It is important to note that the title of the page will always be the first-level header (a single `#`), and your documents should always start with second-level headers (two `##`).\r\n\r\n```\r\n## First-level header in document\r\nText that goes after that.\r\n\r\n### Second-level header in document\r\nText that describes what the second level is about.\r\n```\r\n\r\n### Tables\r\nYour tables need to have an empty line before the first entry. Jekyll does not support rendering all table types without this being done.\r\n\r\n#### Correct\r\n```\r\nBlah blah blah...\r\n\r\n| Header | Information |\r\n|--------|-------------|\r\n| Item 1 | Item 1 data |\r\n| Item 2 | Item 2 data |\r\n| Item 3 | Item 3 data |\r\n```\r\n\r\n#### Incorrect\r\n```\r\nBlah blah blah...\r\n| Header | Information |\r\n|--------|-------------|\r\n| Item 1 | Item 1 data |\r\n| Item 2 | Item 2 data |\r\n| Item 3 | Item 3 data |\r\n```\r\n\r\n### Images\r\nIt is inevitable that you are going to want to include images in your documents, and in most cases you are going to need to resize them in the page, which isn't something that is inherently supported by markdown. In these cases you can use the `<img>` HTML tag with some conditions:\r\n\r\n- The tag should only be used if you need to do some sort of styling (like resizing, etc)\r\n- You should **not** link to an outside source. Any images needed should be copied to the `images` directory in the docs repository.\r\n\r\n### Paths\r\nAll paths need to be relative to each other. The docs repository is converted to GitHub Pages and sits in the `docs` directory, not at the root.\r\n\r\n### Table of Contents\r\nKramdown supports the automatic generation of these, and the pages are automatically generated to include them. You do **not** need to create your own at the top of your pages."},"comment":{"url":"https://api.github.com/repos/red-eclipse/world/issues/comments/353074644","html_url":"https://github.com/red-eclipse/world/issues/9#issuecomment-353074644","issue_url":"https://api.github.com/repos/red-eclipse/world/issues/9","id":353074644,"user":{"login":"qreeves","id":3297929,"avatar_url":"https://avatars0.githubusercontent.com/u/3297929?v=4","gravatar_id":"","url":"https://api.github.com/users/qreeves","html_url":"https://github.com/qreeves","followers_url":"https://api.github.com/users/qreeves/followers","following_url":"https://api.github.com/users/qreeves/following{/other_user}","gists_url":"https://api.github.com/users/qreeves/gists{/gist_id}","starred_url":"https://api.github.com/users/qreeves/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/qreeves/subscriptions","organizations_url":"https://api.github.com/users/qreeves/orgs","repos_url":"https://api.github.com/users/qreeves/repos","events_url":"https://api.github.com/users/qreeves/events{/privacy}","received_events_url":"https://api.github.com/users/qreeves/received_events","type":"User","site_admin":false},"created_at":"2017-12-20T14:18:28Z","updated_at":"2017-12-20T14:18:28Z","author_association":"OWNER","body":"Updated original post with what @IceflowRE has learned."}}
{"actor":{"display_login":"qreeves"}}