{"action":"created","issue":{"url":"https://api.github.com/repos/PebbleTemplates/pebble/issues/411","repository_url":"https://api.github.com/repos/PebbleTemplates/pebble","labels_url":"https://api.github.com/repos/PebbleTemplates/pebble/issues/411/labels{/name}","comments_url":"https://api.github.com/repos/PebbleTemplates/pebble/issues/411/comments","events_url":"https://api.github.com/repos/PebbleTemplates/pebble/issues/411/events","html_url":"https://github.com/PebbleTemplates/pebble/pull/411","id":373757208,"node_id":"MDExOlB1bGxSZXF1ZXN0MjI1NjExNzQw","number":411,"title":"Sets up Pebble documentation site using Orchid","user":{"login":"cjbrooks12","id":6157866,"node_id":"MDQ6VXNlcjYxNTc4NjY=","avatar_url":"https://avatars2.githubusercontent.com/u/6157866?v=4","gravatar_id":"","url":"https://api.github.com/users/cjbrooks12","html_url":"https://github.com/cjbrooks12","followers_url":"https://api.github.com/users/cjbrooks12/followers","following_url":"https://api.github.com/users/cjbrooks12/following{/other_user}","gists_url":"https://api.github.com/users/cjbrooks12/gists{/gist_id}","starred_url":"https://api.github.com/users/cjbrooks12/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cjbrooks12/subscriptions","organizations_url":"https://api.github.com/users/cjbrooks12/orgs","repos_url":"https://api.github.com/users/cjbrooks12/repos","events_url":"https://api.github.com/users/cjbrooks12/events{/privacy}","received_events_url":"https://api.github.com/users/cjbrooks12/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":6,"created_at":"2018-10-25T03:20:02Z","updated_at":"2018-10-25T16:03:52Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/PebbleTemplates/pebble/pulls/411","html_url":"https://github.com/PebbleTemplates/pebble/pull/411","diff_url":"https://github.com/PebbleTemplates/pebble/pull/411.diff","patch_url":"https://github.com/PebbleTemplates/pebble/pull/411.patch"},"body":"This PR adds a new maven project in `docs/` which will generate a documentation site and deploy it to Github Pages, using [Orchid](https://orchid.netlify.com/). The site includes a wiki (migrated from the current Github Wiki) and Javadocs documentation, and also includes a basic full-text search of site content. You can [preview](https://cjbrooks12.github.io/pebble/) the site here. It's pretty basic overall, using one of the built-in themes, but I'm more than happy to make any changes as needed.\r\n\r\nHere's a brief rundown of the new functionality (will still need to be integrated into the current release process):\r\n\r\n**Commands** (run from `docs/` directory)\r\n\r\n- `mvn orchid:serve` - build the site and serve it locally on http://localhost:8080. Changes to site content will rebuild the site. \r\n- `mvn -Denvironment=prod orchid:deploy` - build the site and deploy it to Github Pages. Requires an API token with push access to the repo, set as `githubToken` in the environment variables. The `environment` project property will optimize the build for production.\r\n\r\n**Directory Structure**\r\n\r\n- `docs/src/orchid/resources` - The main root for site content.\r\n  - `site/src/orchid/resources/pages` - Arbitrary static pages\r\n  - `site/src/orchid/resources/wiki` - A `summary.md` file in here declares the pages in the wiki, which are other files relative to this directory. They will automatically be linked to each other in the order they are defined in the summary file.\r\n  - `site/src/orchid/resources/homepage.md` - The content for the front page of the site.\r\n  - `site/src/orchid/resources/config.yml` - Configuration for things like site menus, and theme/plugin options. \r\n\r\n**Deployment**\r\n\r\nOrchid builds the site into the `docs/target/docs/orchid` directory. It has a publication mechanism in it to deploy to Github Pages after a successful build, which creates a temporary directory to do all the git stuff and shouldn't break anything when deploying. It's set up to clean out and force push to the branch, but it has options to maintain history, and also to push each version to a new subdirectory to maintain historical site versions if that is desired. \r\n\r\nI've never worked with Maven so I don't know if this is the correct way to set up the docs project, but everything's working great using the Orchid Maven plugin while in the `docs/` directory. Huge thanks to @bjansen for creating the Maven plugin for this!"},"comment":{"url":"https://api.github.com/repos/PebbleTemplates/pebble/issues/comments/433109821","html_url":"https://github.com/PebbleTemplates/pebble/pull/411#issuecomment-433109821","issue_url":"https://api.github.com/repos/PebbleTemplates/pebble/issues/411","id":433109821,"node_id":"MDEyOklzc3VlQ29tbWVudDQzMzEwOTgyMQ==","user":{"login":"bjansen","id":281528,"node_id":"MDQ6VXNlcjI4MTUyOA==","avatar_url":"https://avatars1.githubusercontent.com/u/281528?v=4","gravatar_id":"","url":"https://api.github.com/users/bjansen","html_url":"https://github.com/bjansen","followers_url":"https://api.github.com/users/bjansen/followers","following_url":"https://api.github.com/users/bjansen/following{/other_user}","gists_url":"https://api.github.com/users/bjansen/gists{/gist_id}","starred_url":"https://api.github.com/users/bjansen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bjansen/subscriptions","organizations_url":"https://api.github.com/users/bjansen/orgs","repos_url":"https://api.github.com/users/bjansen/repos","events_url":"https://api.github.com/users/bjansen/events{/privacy}","received_events_url":"https://api.github.com/users/bjansen/received_events","type":"User","site_admin":false},"created_at":"2018-10-25T16:03:52Z","updated_at":"2018-10-25T16:03:52Z","author_association":"CONTRIBUTOR","body":"Weird, when I load the same page a second time, it's super fast. I'll blame the proxy we have at work :)"}}
{"actor":{"display_login":"bjansen"}}