Add support for Algolia DocSearch #127
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Aha, I was wondering why I was getting your site's Algolia search results in the preview search box until I actually read your message properly. Do you mind me asking how long it took to get your Algolia javascript back, as I'm going to apply for Docsy and Goldydocs? It would be nice for users who choose this feature to be able to see it working on our site or a local copy once they toggle the search engine. I'll take a proper look at your implementation now. |
|
Also thanks so much for doing this and sorry for the delay in reviewing! |
|
No problem @LisaFC :) It only took a couple of days for Algolia to get back to me with the Javascript. First they'll send you an email to verify that you are a site owner/maintainer and once I replied to that I got the Javascript the next day. |
LisaFC
reviewed
Sep 25, 2019
LisaFC
reviewed
Sep 27, 2019
|
@LisaFC thanks for the feedback I'll get back to this as soon as I can, but it will likely be a few days. |
|
No rush, thanks again for doing this! :) |
|
@LisaFC I've made the suggested changes now. I tested this locally and on netlify preview with my own Javascript code, and now I've removed the Javascript and just left the comments. This should be ready to merge now unless I've missed something ;) Also did a PR for the config file on the example site google/docsy-example#30 |
|
Ah, you're a star, this is great! |
|
BTW, going to big this nice new feature up to our not very many followers on social media (https://twitter.com/docsydocs), do you mind me using your name or do you have a public Twitter? |
|
Cool, I'm not on twitter so you can use my name np. Thanks :) |
slevin
added a commit
to yahoo/bgdocs
that referenced
this pull request
Feb 2, 2022
* Update _index.html * Update _index.html * Update _index.html * Update _index.html * Update _index.html * Use new community template * Update _index.html * Update _index.html * Update _index.html * Update _index.html * any ould resources * Update _index.html * Rename _index.html to _index.md * Update _index.md * Update _index.md * Update _index.md * Doc section reorg, Docsy-fying, and updated instructions * Update theme module * Update theme module * Generalized blog text. Removed files that might cause confusion. * Minor tweaks to instructions * Update README.md * Create LICENSE * added disclaimer to README * removed generated resources folder * Add license boilerplate * add contributing guide * Update README.md Fixed repo names in README * Removed submodule * Added up to date theme module * Update config.toml updated theme name * Update _index.md * Update _index.md Remind users that sudo apt-get install hugo gets you a Very Old Version * Update README.md * Fix workaround instructions * Update _index.md Mention minimum Hugo version for Netlify * Update config.toml * Update _index.html * Update README.md * Update _index.md * Rename _index.md to .._index.md * Rename content/en/docs/How-tos/.._index.md to content/en/docs/Tasks/_index.md * Rename content/en/docs/How-tos/knitting-paragraphs.md to content/en/docs/Tasks/knitting-paragraphs.md * Rename content/en/docs/How-tos/weaving-words.md to content/en/docs/Tasks/weaving-words.md * Rename content/en/docs/How-tos/Ponycopters/_index.md to content/en/docs/Tasks/Ponycopters/_index.md * Rename content/en/docs/How-tos/Ponycopters/configuring-ponycopters.md to content/en/docs/Tasks/Ponycopters/configuring-ponycopters.md * Rename content/en/docs/How-tos/Ponycopters/launching-ponycopters.md to content/en/docs/Tasks/Ponycopters/launching-ponycopters.md * improved favicon instructions * update theme submodule * Fixed a typo and some code formatting. * More detail on landing pages and templates * Info on updating the theme * Update _index.md * Update _index.md * Fixing a badly used shortcode... * Update _index.md * Update README.md * update config to demonstrate feedback widget * s/ocassionally/occasionally/ * s/ocasionally/occasionally/ * Updating theme submodule * Linking to the staged website from the README. * Fixing broken link to example repository. * Clarified where to find the user guide. * Updating theme submodule * Adding resources * Adding instructions * Goldydocs rebranding part one... * More content updates/simplification/porridgification * Updated tasks page * Improved overview instructions * Contribution guidelines * Contribution guidelines * Updating theme submodule * Making the templatey nature more explicit * Updated example getting started page * Fix default baseURL or things go weird with absolute URLs in menus.... * Update config.toml * Update config.toml * Bump js-yaml from 3.12.1 to 3.13.1 Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.1 to 3.13.1. - [Release notes](https://github.com/nodeca/js-yaml/releases) - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@3.12.1...3.13.1) Signed-off-by: dependabot[bot] <[email protected]> * Update config.toml Co-Authored-By: RichieEscarez <[email protected]> * Update config.toml Co-Authored-By: RichieEscarez <[email protected]> * Updating theme submodule * tiny change for github subdir * small change to github subdir * remove redundant resources folder * Update README.md * Update README.md Removed reference to nonexistent theme docs in this repo * removing redundant files * Update config.toml * Added links to user guide repo * 404 page * Update _index.md * Changing placekitten links to be https * Update _index.html * Adding missing title to README.md * updating theme * Update README.md * Bump lodash from 4.17.11 to 4.17.14 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.14. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.11...4.17.14) Signed-off-by: dependabot[bot] <[email protected]> * Add config option for about link in footer I needed a way to disable the About link in the footer and discovered this option by looking in the code. It's working for my site using the Docsy theme so I thought other people might benefit from knowing about it. * Change the value to false Changed the value to false so the Docsy example site is not affected * Move images to params.images * Bump mixin-deep from 1.3.1 to 1.3.2 Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. - [Release notes](https://github.com/jonschlinkert/mixin-deep/releases) - [Commits](jonschlinkert/mixin-deep@1.3.1...1.3.2) Signed-off-by: dependabot[bot] <[email protected]> * Updating theme submodule * Update config.toml Add a param for Algolia docsearch, related to PR on Docsy theme google/docsy#127 * Adding offlineSearch param As requested in https://github.com/google/docsy/pull/142/files#r338549380 * Bump packages with CVEs * Create search-index.md * Updating theme submodule * Update _index.md * Let Goldmark render raw HTML * Remove div that's confusing Goldmark Fixes google/docsy#174 * Added parameters for version banner. * Updating theme submodule * Updating theme submodule * Remove a unnecessary file (content/en/search-index.md) * Add reading time parameter * Updating theme submodule * Fix typo descripton -> description * point to google/docsy-example instead * update package.json and package-lock.json + Update dev dependencies to latest versions. (I confirmed that running `hugo server` and viewing the site works as expected.) + Fix URLs in package file. Fixes #45. * Create dependabot.yml Help keep the dev dependencies up to date. https://dependabot.com/#how-it-works * fixing typo * Bump lodash from 4.17.15 to 4.17.19 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.15...4.17.19) Signed-off-by: dependabot[bot] <[email protected]> * Update config.toml Update to work with latest Chroma style support * Updating theme submodule * Updating theme submodule * Bump autoprefixer from 9.8.0 to 9.8.6 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.0 to 9.8.6. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/master/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.0...9.8.6) Signed-off-by: dependabot[bot] <[email protected]> * add dockerfile and change readme with instructions to build and run the docker image * Bump postcss-cli from 7.1.1 to 7.1.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 7.1.1 to 7.1.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@7.1.1...7.1.2) Signed-off-by: dependabot[bot] <[email protected]> * Updating theme submodule * Add config param for prism relates to google/docsy#325 * Set the prism option to false by default * Fixing broken links * Updating Docsy submodule * Updating theme submodule * Update docsy theme & enable 'print entire section' * Add persian translations. * Update README.md Add template instructions * Updating theme submodule * 🏗️ Dockerfile + docker-compose.yaml build/running Add Dockerfile for building with the latest and the docker-compose, building the site and running. $ docker-compose up Starting docsy-example_site_1 ... done Attaching to docsy-example_site_1 site_1 | Start building sites … site_1 | site_1 | | FA | NO | EN site_1 | -------------------+----+----+----- site_1 | Pages | 18 | 76 | 46 site_1 | Paginator pages | 0 | 0 | 0 site_1 | Non-page files | 3 | 1 | 3 site_1 | Static files | 38 | 38 | 38 site_1 | Processed images | 8 | 2 | 7 site_1 | Aliases | 3 | 0 | 3 site_1 | Sitemaps | 2 | 1 | 1 site_1 | Cleaned | 0 | 0 | 0 site_1 | site_1 | Built in 837 ms site_1 | Watching for changes in /src/{assets,content,layouts,package.json,themes} site_1 | Watching for config changes in /src/config.toml, /src/themes/docsy/config.toml site_1 | Environment: "DEV" site_1 | Serving pages from memory site_1 | Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender site_1 | Web Server is available at //localhost:1313/ (bind address 0.0.0.0) site_1 | Press Ctrl+C to stop Open a new terminal and test it $ curl -X HEAD -i localhost:1313 Warning: Setting custom HTTP method to HEAD with -X/--request may not work the Warning: way you want. Consider using -I/--head instead. HTTP/1.1 200 OK Accept-Ranges: bytes Content-Length: 27590 Content-Type: text/html; charset=utf-8 Last-Modified: Thu, 17 Dec 2020 08:47:13 GMT Date: Thu, 17 Dec 2020 08:47:25 GMT * Update to latest Docsy * Add a troubleshooting section. Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main. Solution: install hugo-extended Signed-off-by: Gaurav Gahlot <[email protected]> * Update README.md * 🐳 Dockerfile: Use the repo name as image tag * 📝 README: add steps with docker-compose Running with docker-compose is simpler for this case * Update Docker Compose instructions. * Fix indentation * Make cleanup steps a subsection * Add github_branch * Dockerfile: use base image with extended version of Hugo * Update search engine Fixes google/docsy#479 * Bump y18n from 4.0.0 to 4.0.1 Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <[email protected]> * Dockerfile: use klakegg/hugo:ext-alpine * Bump lodash from 4.17.20 to 4.17.21 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.20...4.17.21) Signed-off-by: dependabot[bot] <[email protected]> * Bump browserslist from 4.14.0 to 4.16.6 Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.14.0 to 4.16.6. - [Release notes](https://github.com/browserslist/browserslist/releases) - [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md) - [Commits](browserslist/browserslist@4.14.0...4.16.6) Signed-off-by: dependabot[bot] <[email protected]> * Bump glob-parent from 5.1.1 to 5.1.2 Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/gulpjs/glob-parent/releases) - [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md) - [Commits](gulpjs/glob-parent@v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: glob-parent dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> * Bump postcss from 7.0.32 to 7.0.36 Bumps [postcss](https://github.com/postcss/postcss) from 7.0.32 to 7.0.36. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@7.0.32...7.0.36) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> * Updating theme submodule * Update config.toml * Updating theme submodule * Add taxonomy sample code Enable taxonomoy in `config.toml` and add tags and categories to the FrontMatter in the "Getting Started" docs. * Add navbar_translucent_over_cover_disable and sort ui elements * Delete package-lock.json and ignore it * Add a netlify.toml and update HUGO_VERSION * Update package.json: postcss* * Flip incorrect boolean in comment Fixes #141 * README: add link to deploy-logs * Min version of Node is latest LTS version * Add link to official Netlify dashboard * Bump autoprefixer from 9.8.8 to 10.4.0 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.8 to 10.4.0. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.8...10.4.0) --- updated-dependencies: - dependency-name: autoprefixer dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Bump postcss-cli from 8.3.1 to 9.0.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 8.3.1 to 9.0.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@8.3.1...9.0.2) --- updated-dependencies: - dependency-name: postcss-cli dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Bumped docsy theme to latest version * examples, api and intro docs * Tutorial 1 first draft * tutorials 2 and 3 * more cleanup * tutorial 2 and feedback page * tutorial 3 cleanup * release 1.0 js prep * add generated typescript version * use shortcode to allow serving from subdirectory like in github pages * update generated typescript docs for relative image locations Co-authored-by: LisaFC <[email protected]> Co-authored-by: rionam <[email protected]> Co-authored-by: Lisa Carey <[email protected]> Co-authored-by: Sarah Maddox <[email protected]> Co-authored-by: Kayce Basques <[email protected]> Co-authored-by: Kayce Basques <[email protected]> Co-authored-by: Aijamal NK <[email protected]> Co-authored-by: Andrew Chen <[email protected]> Co-authored-by: Sharif Salah <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: RichieEscarez <[email protected]> Co-authored-by: Erin McKean <[email protected]> Co-authored-by: Kshithij Iyer <[email protected]> Co-authored-by: Alex Earnshaw <[email protected]> Co-authored-by: Yamagishi Kazutoshi <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Austin Macdonald <[email protected]> Co-authored-by: Sarah Maddox <[email protected]> Co-authored-by: Takayama Fumihiko <[email protected]> Co-authored-by: Lisa Carey <[email protected]> Co-authored-by: Ulf Adams <[email protected]> Co-authored-by: Daniel Holbach <[email protected]> Co-authored-by: Jeff Williams <[email protected]> Co-authored-by: Christian Oliff <[email protected]> Co-authored-by: Christoph Raaflaub <[email protected]> Co-authored-by: Geri Ochoa <[email protected]> Co-authored-by: Alex Earnshaw <[email protected]> Co-authored-by: Andreas Deininger <[email protected]> Co-authored-by: Gareth Watts <[email protected]> Co-authored-by: theSinner <[email protected]> Co-authored-by: Marcello de Sales <[email protected]> Co-authored-by: Gaurav Gahlot <[email protected]> Co-authored-by: Daan Seynaeve <[email protected]> Co-authored-by: Patrice Chalin <[email protected]> Co-authored-by: Mark Hansen <[email protected]> Co-authored-by: Andreas Deininger <[email protected]> Co-authored-by: Sean Levin <[email protected]>
judyheflin
pushed a commit
to awslabs/kubeflow-manifests
that referenced
this pull request
Apr 22, 2022
* Update _index.md * Rename _index.md to .._index.md * Rename content/en/docs/How-tos/.._index.md to content/en/docs/Tasks/_index.md * Rename content/en/docs/How-tos/knitting-paragraphs.md to content/en/docs/Tasks/knitting-paragraphs.md * Rename content/en/docs/How-tos/weaving-words.md to content/en/docs/Tasks/weaving-words.md * Rename content/en/docs/How-tos/Ponycopters/_index.md to content/en/docs/Tasks/Ponycopters/_index.md * Rename content/en/docs/How-tos/Ponycopters/configuring-ponycopters.md to content/en/docs/Tasks/Ponycopters/configuring-ponycopters.md * Rename content/en/docs/How-tos/Ponycopters/launching-ponycopters.md to content/en/docs/Tasks/Ponycopters/launching-ponycopters.md * improved favicon instructions * update theme submodule * Fixed a typo and some code formatting. * More detail on landing pages and templates * Info on updating the theme * Update _index.md * Update _index.md * Fixing a badly used shortcode... * Update _index.md * Update README.md * update config to demonstrate feedback widget * s/ocassionally/occasionally/ * s/ocasionally/occasionally/ * Updating theme submodule * Linking to the staged website from the README. * Fixing broken link to example repository. * Clarified where to find the user guide. * Updating theme submodule * Adding resources * Adding instructions * Goldydocs rebranding part one... * More content updates/simplification/porridgification * Updated tasks page * Improved overview instructions * Contribution guidelines * Contribution guidelines * Updating theme submodule * Making the templatey nature more explicit * Updated example getting started page * Fix default baseURL or things go weird with absolute URLs in menus.... * Update config.toml * Update config.toml * Bump js-yaml from 3.12.1 to 3.13.1 Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.1 to 3.13.1. - [Release notes](https://github.com/nodeca/js-yaml/releases) - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@3.12.1...3.13.1) Signed-off-by: dependabot[bot] <[email protected]> * Update config.toml Co-Authored-By: RichieEscarez <[email protected]> * Update config.toml Co-Authored-By: RichieEscarez <[email protected]> * Updating theme submodule * tiny change for github subdir * small change to github subdir * remove redundant resources folder * Update README.md * Update README.md Removed reference to nonexistent theme docs in this repo * removing redundant files * Update config.toml * Added links to user guide repo * 404 page * Update _index.md * Changing placekitten links to be https * Update _index.html * Adding missing title to README.md * updating theme * Update README.md * Bump lodash from 4.17.11 to 4.17.14 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.14. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.11...4.17.14) Signed-off-by: dependabot[bot] <[email protected]> * Add config option for about link in footer I needed a way to disable the About link in the footer and discovered this option by looking in the code. It's working for my site using the Docsy theme so I thought other people might benefit from knowing about it. * Change the value to false Changed the value to false so the Docsy example site is not affected * Move images to params.images * Bump mixin-deep from 1.3.1 to 1.3.2 Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. - [Release notes](https://github.com/jonschlinkert/mixin-deep/releases) - [Commits](jonschlinkert/mixin-deep@1.3.1...1.3.2) Signed-off-by: dependabot[bot] <[email protected]> * Updating theme submodule * Update config.toml Add a param for Algolia docsearch, related to PR on Docsy theme google/docsy#127 * Adding offlineSearch param As requested in https://github.com/google/docsy/pull/142/files#r338549380 * Bump packages with CVEs * Create search-index.md * Updating theme submodule * Update _index.md * Let Goldmark render raw HTML * Remove div that's confusing Goldmark Fixes google/docsy#174 * Added parameters for version banner. * Updating theme submodule * Updating theme submodule * Remove a unnecessary file (content/en/search-index.md) * Add reading time parameter * Updating theme submodule * Fix typo descripton -> description * point to google/docsy-example instead * update package.json and package-lock.json + Update dev dependencies to latest versions. (I confirmed that running `hugo server` and viewing the site works as expected.) + Fix URLs in package file. Fixes #45. * Create dependabot.yml Help keep the dev dependencies up to date. https://dependabot.com/#how-it-works * fixing typo * Bump lodash from 4.17.15 to 4.17.19 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.15...4.17.19) Signed-off-by: dependabot[bot] <[email protected]> * Update config.toml Update to work with latest Chroma style support * Updating theme submodule * Updating theme submodule * Bump autoprefixer from 9.8.0 to 9.8.6 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.0 to 9.8.6. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/master/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.0...9.8.6) Signed-off-by: dependabot[bot] <[email protected]> * add dockerfile and change readme with instructions to build and run the docker image * Bump postcss-cli from 7.1.1 to 7.1.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 7.1.1 to 7.1.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@7.1.1...7.1.2) Signed-off-by: dependabot[bot] <[email protected]> * Updating theme submodule * Add config param for prism relates to google/docsy#325 * Set the prism option to false by default * Fixing broken links * Updating Docsy submodule * Updating theme submodule * Update docsy theme & enable 'print entire section' * Add persian translations. * Update README.md Add template instructions * Updating theme submodule * 🏗️ Dockerfile + docker-compose.yaml build/running Add Dockerfile for building with the latest and the docker-compose, building the site and running. $ docker-compose up Starting docsy-example_site_1 ... done Attaching to docsy-example_site_1 site_1 | Start building sites … site_1 | site_1 | | FA | NO | EN site_1 | -------------------+----+----+----- site_1 | Pages | 18 | 76 | 46 site_1 | Paginator pages | 0 | 0 | 0 site_1 | Non-page files | 3 | 1 | 3 site_1 | Static files | 38 | 38 | 38 site_1 | Processed images | 8 | 2 | 7 site_1 | Aliases | 3 | 0 | 3 site_1 | Sitemaps | 2 | 1 | 1 site_1 | Cleaned | 0 | 0 | 0 site_1 | site_1 | Built in 837 ms site_1 | Watching for changes in /src/{assets,content,layouts,package.json,themes} site_1 | Watching for config changes in /src/config.toml, /src/themes/docsy/config.toml site_1 | Environment: "DEV" site_1 | Serving pages from memory site_1 | Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender site_1 | Web Server is available at //localhost:1313/ (bind address 0.0.0.0) site_1 | Press Ctrl+C to stop Open a new terminal and test it $ curl -X HEAD -i localhost:1313 Warning: Setting custom HTTP method to HEAD with -X/--request may not work the Warning: way you want. Consider using -I/--head instead. HTTP/1.1 200 OK Accept-Ranges: bytes Content-Length: 27590 Content-Type: text/html; charset=utf-8 Last-Modified: Thu, 17 Dec 2020 08:47:13 GMT Date: Thu, 17 Dec 2020 08:47:25 GMT * Update to latest Docsy * Add a troubleshooting section. Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main. Solution: install hugo-extended Signed-off-by: Gaurav Gahlot <[email protected]> * Update README.md * 🐳 Dockerfile: Use the repo name as image tag * 📝 README: add steps with docker-compose Running with docker-compose is simpler for this case * Update Docker Compose instructions. * Fix indentation * Make cleanup steps a subsection * Add github_branch * Dockerfile: use base image with extended version of Hugo * Update search engine Fixes google/docsy#479 * Bump y18n from 4.0.0 to 4.0.1 Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <[email protected]> * Dockerfile: use klakegg/hugo:ext-alpine * Bump lodash from 4.17.20 to 4.17.21 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.20...4.17.21) Signed-off-by: dependabot[bot] <[email protected]> * Bump browserslist from 4.14.0 to 4.16.6 Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.14.0 to 4.16.6. - [Release notes](https://github.com/browserslist/browserslist/releases) - [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md) - [Commits](browserslist/browserslist@4.14.0...4.16.6) Signed-off-by: dependabot[bot] <[email protected]> * Bump glob-parent from 5.1.1 to 5.1.2 Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/gulpjs/glob-parent/releases) - [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md) - [Commits](gulpjs/glob-parent@v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: glob-parent dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> * Bump postcss from 7.0.32 to 7.0.36 Bumps [postcss](https://github.com/postcss/postcss) from 7.0.32 to 7.0.36. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@7.0.32...7.0.36) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> * Updating theme submodule * Update config.toml * Updating theme submodule * Add taxonomy sample code Enable taxonomoy in `config.toml` and add tags and categories to the FrontMatter in the "Getting Started" docs. * Add navbar_translucent_over_cover_disable and sort ui elements * Delete package-lock.json and ignore it * Add a netlify.toml and update HUGO_VERSION * Update package.json: postcss* * Flip incorrect boolean in comment Fixes #141 * README: add link to deploy-logs * Min version of Node is latest LTS version * Add link to official Netlify dashboard * Bump autoprefixer from 9.8.8 to 10.4.0 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.8 to 10.4.0. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.8...10.4.0) --- updated-dependencies: - dependency-name: autoprefixer dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Bump postcss-cli from 8.3.1 to 9.0.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 8.3.1 to 9.0.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@8.3.1...9.0.2) --- updated-dependencies: - dependency-name: postcss-cli dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * config.toml: replace tabs with whitespace * Bumped docsy theme to latest version * README.md: correct dead link (installing/using themes) (#160) * config.toml: change order of language settings and theme/module declaration (#162) * Updating docsy theme submodule (#164) * config.toml: comment typo: s/lang/length I don't think taxonomyCloud has a language, and I think they need to have the same length, so I think this is what was intended. * Leave param name unqualified in comment * Make docsy example site use docsy theme as hugo module (#156) * docsy as module: refer to current HEAD of repo (#169) * Remove outdated deployment script (#170) * Update example site to docsy theme v0.2.0 (#171) * README.md: reflect changes due to use of theme as hugo module (#172) * Checkpoint for Kubeflow on AWS 1.4 docs staging 4/12 7:47pm * Finished About section organization * Fixed AWS logos and updated docs structure * AWS-specific doc restructuring * About page notes update * Added prereq page and deployment drafts * Added Profiles component guide * Restructured Deployment docs for KF on AWS website * Syncing About, Deployment, and Components section * Added AWS Labs kubeflow-manifests doc issue template to feedback prompt * Staged Uninstall deployment doc * Fixed Uninstall relative links * Move all files into src/website directory * Cleaned up extra files * Added website working directory to kubeflow-manifests repo * Added Hugo Docsy theme submodule * Testing GitHub actions build * Modified Config file for testing * Removed GH actions test * Added PostCSS dependency * GH actions test #2 * GH actions test #3 * Restructured deployment pages * Updated RDS&S3, EFS, and FSx installation guides based on recent PRs * Reverted file structure and refreshed EFS/FSx/RDS&S3 docs * GH actions test * Removed GH workflows script * Minimized docs pages for website staging * Load balancer installation guide refresh * Updated Usage Tracking command for KF on AWS * Finished uninstall and RDS S3 pages * Finished vanilla guide edits * Deployment PR feedback and link fixes Co-authored-by: LisaFC <[email protected]> Co-authored-by: Sarah Maddox <[email protected]> Co-authored-by: Kayce Basques <[email protected]> Co-authored-by: Kayce Basques <[email protected]> Co-authored-by: Aijamal NK <[email protected]> Co-authored-by: Andrew Chen <[email protected]> Co-authored-by: Sharif Salah <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: RichieEscarez <[email protected]> Co-authored-by: Erin McKean <[email protected]> Co-authored-by: Kshithij Iyer <[email protected]> Co-authored-by: Alex Earnshaw <[email protected]> Co-authored-by: Yamagishi Kazutoshi <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Austin Macdonald <[email protected]> Co-authored-by: Sarah Maddox <[email protected]> Co-authored-by: Takayama Fumihiko <[email protected]> Co-authored-by: Lisa Carey <[email protected]> Co-authored-by: Ulf Adams <[email protected]> Co-authored-by: Daniel Holbach <[email protected]> Co-authored-by: Jeff Williams <[email protected]> Co-authored-by: Christian Oliff <[email protected]> Co-authored-by: Christoph Raaflaub <[email protected]> Co-authored-by: Geri Ochoa <[email protected]> Co-authored-by: Alex Earnshaw <[email protected]> Co-authored-by: Andreas Deininger <[email protected]> Co-authored-by: Gareth Watts <[email protected]> Co-authored-by: theSinner <[email protected]> Co-authored-by: Marcello de Sales <[email protected]> Co-authored-by: Gaurav Gahlot <[email protected]> Co-authored-by: Daan Seynaeve <[email protected]> Co-authored-by: Patrice Chalin <[email protected]> Co-authored-by: Mark Hansen <[email protected]> Co-authored-by: Andreas Deininger <[email protected]> Co-authored-by: Andreas Deininger <[email protected]> Co-authored-by: Patrice Chalin <[email protected]>
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in #126 this is a PR for using Algolia DocSearch as an alternative to GCSE.
To test that the search displays correctly for the Docsy user guide I've used the Algolia Javascript from my site in the Docsy head end and body end. I've verified this works locally, but of course it display search results from my site. These changes will need to be removed before this PR is merged.
Similarly the config.toml changes are added here only for testing purposes and need to be removed before merging. I guess the new param needs to be added in the Docsy example project instead?
The change I've made to search-input.html works but is probably not the best way to do it? I'd appreciate any guidance here :)