{"action":"created","issue":{"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/issues/176","repository_url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org","labels_url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/issues/176/labels{/name}","comments_url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/issues/176/comments","events_url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/issues/176/events","html_url":"https://github.com/silverstripe/doc.silverstripe.org/issues/176","id":317962413,"number":176,"title":"Use Swiftype for search","user":{"login":"chillu","id":111025,"avatar_url":"https://avatars3.githubusercontent.com/u/111025?v=4","gravatar_id":"","url":"https://api.github.com/users/chillu","html_url":"https://github.com/chillu","followers_url":"https://api.github.com/users/chillu/followers","following_url":"https://api.github.com/users/chillu/following{/other_user}","gists_url":"https://api.github.com/users/chillu/gists{/gist_id}","starred_url":"https://api.github.com/users/chillu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chillu/subscriptions","organizations_url":"https://api.github.com/users/chillu/orgs","repos_url":"https://api.github.com/users/chillu/repos","events_url":"https://api.github.com/users/chillu/events{/privacy}","received_events_url":"https://api.github.com/users/chillu/received_events","type":"User","site_admin":false},"labels":[{"id":664050784,"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/labels/change/minor","name":"change/minor","color":"f9d0c4","default":false},{"id":664050807,"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/labels/effort/medium","name":"effort/medium","color":"fef2c0","default":false},{"id":664050846,"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/labels/impact/high","name":"impact/high","color":"eb6420","default":false},{"id":664050891,"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/labels/type/docs","name":"type/docs","color":"02d7e1","default":false},{"id":13209657,"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/labels/type/enhancement","name":"type/enhancement","color":"0e8a16","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-04-26T10:09:38Z","updated_at":"2018-04-26T19:52:33Z","closed_at":null,"author_association":"OWNER","body":"# Overview\r\n\r\nThe current search is useless: It indexes changelogs, which leads to a large amount of irrelevant results. It also uses a one-off search solution (Lucene PHP), which is hard to maintain and customise. While we could fix the short-term issues, there's little value in keeping a custom search engine overall - particularly now that we have Swiftype across silverstripe.com and silverstripe.org already.\r\n\r\n# Acceptance Criteria\r\n\r\n * Crawls doc.silverstripe.org and api.silverstripe.org\r\n * Search indexes supported major and minor versions (3.5, 3.6, 4.0, 4.1)\r\n * Search indexes supported master\r\n * Search defaults to currently viewed version\r\n * New content is automatically picked up in search results (after max 24h)\r\n * Documentation search results are integrated on silverstripe.org main search\r\n * Search results show extract\r\n * Search results show the source domain\r\n * Search results exclude changelogs\r\n * Search queries get picked up by Google Analytics\r\n * Prioritises results from https://www.silverstripe.org/learn/lessons/\r\n * You can link to search results\r\n * Any code, templates and documentation for previous PHP-based search are removed from the doc.silverstripe.org codebase\r\n * Uses the same swiftype account as silverstripe.org & silverstripe.com\r\n\r\n# Notes\r\n\r\n * We should just remove old versions from doc.silverstripe.org, rather than doing any form of whitelisting in Swiftype - which will be a burden every time we bring out a new release.\r\n * Does not need custom styling, just use whatever Swiftype does by default\r\n * There are 414 *.md files in `docs/en` for 4.x (242 of those are changelogs)\r\n * There are 760 matches for `api.silverstripe.org/4/*`\r\n * Overall we're looking at less than 5k docs.\r\n * Currently the docs are building from branches rather than stable versions, showing docs for unreleased feature - which is confusing. That's out of scope here.\r\n * No need for explicit search filters for versions, just search whatever is displayed\r\n * We might be able to remove this again if we switch the whole doc.silverstripe.org to ReadTheDocs.org: https://github.com/silverstripe/doc.silverstripe.org/issues/157\r\n * Swiftype cost approved by Sam"},"comment":{"url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/issues/comments/384768685","html_url":"https://github.com/silverstripe/doc.silverstripe.org/issues/176#issuecomment-384768685","issue_url":"https://api.github.com/repos/silverstripe/doc.silverstripe.org/issues/176","id":384768685,"user":{"login":"chillu","id":111025,"avatar_url":"https://avatars3.githubusercontent.com/u/111025?v=4","gravatar_id":"","url":"https://api.github.com/users/chillu","html_url":"https://github.com/chillu","followers_url":"https://api.github.com/users/chillu/followers","following_url":"https://api.github.com/users/chillu/following{/other_user}","gists_url":"https://api.github.com/users/chillu/gists{/gist_id}","starred_url":"https://api.github.com/users/chillu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chillu/subscriptions","organizations_url":"https://api.github.com/users/chillu/orgs","repos_url":"https://api.github.com/users/chillu/repos","events_url":"https://api.github.com/users/chillu/events{/privacy}","received_events_url":"https://api.github.com/users/chillu/received_events","type":"User","site_admin":false},"created_at":"2018-04-26T19:52:33Z","updated_at":"2018-04-26T19:52:33Z","author_association":"OWNER","body":"Added :)"}}
{"actor":{"display_login":"chillu"}}