Website global search feature #18288

ys2843 · 2020-05-12T06:29:06Z

Description

This PR implements the website global search feature outlined in this GitHub issue. It added a fully functional search bar powered by DocSearch, capable of searching across all site in any version, located on the right side of main Nav bar with a drop down menu attached that contains all available version options.

Checklist

Essentials

Changes are complete (i.e. I finished coding on this PR)
Code is well-documented
To the best of my knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

M docs/static_site/src/_includes/head.html
M docs/static_site/src/_includes/header.html
M docs/static_site/src/assets/main.scss
M docs/static_site/src/_sass/minima/_layout.scss
Add docs/static_site/src/assets/img/search-icon.svg
Add docs/static_site/src/assets/js/globalSearch.js
Add docs/static_site/src/_sass/globalSearch.scss

Comments

Preview link: http://[email protected]/
Please note the preview only has global search on master version, in production 1.6 will also be supported
This PR is ready to merge

mxnet-bot · 2020-05-12T06:29:10Z

Hey @ys2843 , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:

To trigger all jobs: @mxnet-bot run ci [all]
To trigger specific jobs: @mxnet-bot run ci [job1, job2]

CI supported jobs: [unix-cpu, windows-gpu, miscellaneous, centos-cpu, windows-cpu, centos-gpu, clang, unix-gpu, edge, website, sanity]

Note:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.

ys2843 · 2020-05-12T06:30:44Z

@mxnet-label-bot update [pr-awaiting-merge]

docs/static_site/src/_includes/header.html

ChaiBapchya · 2020-05-14T18:56:12Z

Search feature looks great.
Nice to see we leveraging third-party to solve our search problem.
Q1. This feature is currently only for landing page right?
It isn't available on other pages right?
For e.g. not available in Python API > NDArray page right?
http://ec2-34-219-134-42.us-west-2.compute.amazonaws.com/api/python/docs/api/ndarray/index.html

Can we document this point. And also add this functionality to rest of the pages in upcoming PRs?

Q2 Is search suggestion pointing to the correct place?
When I search for copyto in 1.6 version on a laptop browser
It navigates to https://mxnet.apache.org/versions/1.6/api/python/docs/api/ndarray/ndarray.html?astype=#ndarray

Isn't it supposed to go to the copyto operator specifically instead of the head of the div [ndarray]

ys2843 · 2020-05-14T20:23:46Z

Search feature looks great.
Nice to see we leveraging third-party to solve our search problem.
Q1. This feature is currently only for landing page right?
It isn't available on other pages right?
For e.g. not available in Python API > NDArray page right?
http://ec2-34-219-134-42.us-west-2.compute.amazonaws.com/api/python/docs/api/ndarray/index.html

Can we document this point. And also add this functionality to rest of the pages in upcoming PRs?

Q2 Is search suggestion pointing to the correct place?
When I search for copyto in 1.6 version on a laptop browser
It navigates to https://mxnet.apache.org/versions/1.6/api/python/docs/api/ndarray/ndarray.html?astype=#ndarray

Isn't it supposed to go to the copyto operator specifically instead of the head of the div [ndarray]

Thank you for reviewing! Good questions.
Q1: Yes, it is available on all landing pages (that don't have a search bar currently), and not on any of the API docs pages. The reason is that while there is already a search bar on all API docs pages, in my opinion adding another one can confuse users. Here is a similar example, I think 1 search bar per page looks clear.
Q2: Good point. This is related to improvement of search result, I am currently working on these issues. It is mainly about how we configure the web crawler to grab data from our website, and it does not require any code changes to MXNet website.

aaronmarkham

Looks good.

Should we use offsite js files or host locally?
Should the API key be in a js file are can it be in a config file so we keep this stuff in someplace central?
Wonder if we could have the list of versions also in a config file and not in .js, so it is more obvious and easier to maintain... then other parts of the site like the install selector or other things that need the list of versions can share?

Just some thoughts... otherwise this looks good to me.
Good work!

docs/static_site/src/_includes/head.html

docs/static_site/src/assets/js/globalSearch.js

ys2843 · 2020-05-15T02:31:49Z

Looks good.

Should we use offsite js files or host locally?

Should the API key be in a js file are can it be in a config file so we keep this stuff in someplace central?

Wonder if we could have the list of versions also in a config file and not in .js, so it is more obvious and easier to maintain... then other parts of the site like the install selector or other things that need the list of versions can share?

Just some thoughts... otherwise this looks good to me.
Good work!

Should we use offsite js files or host locally?

Based on the research, the CDN works pretty well in China. I will keep an eye on it, if there is problem loading this file in any country, I will switch to host the file locally.

Should the API key be in a js file are can it be in a config file so we keep this stuff in someplace central?

Didn't move API key to Jekyll at last, because Jekyll does not work very well with files such as assets/*.js, the way to get variable from Jekyll to JS is not straight forward ( use _include), please correct me if I am wrong. And after this version is archived, it is also easier to maintain if the key is kept in 1 JS file, but not spread to every page by Jekyll include <script>.

Wonder if we could have the list of versions also in a config file and not in .js, so it is more obvious and easier to maintain... then other parts of the site like the install selector or other things that need the list of versions can share?

Great idea, I will set these common variables as Jekyll global var and generate the HTML when compiling Jekyll

sandeep-krishnamurthy · 2020-05-15T18:58:49Z

@mxnet-bot run ci [unix-cpu]

mxnet-bot · 2020-05-15T18:58:57Z

Jenkins CI successfully triggered : [unix-cpu]

sandeep-krishnamurthy

Very nice. Thank you @ys2843 This will be very helpful for the community.
Please update the release manager checklist for changing the defaults.

Should we change anything with algolia (like default version) whenever there is a new release?
Also, for updating the search results, what is the process? What do you mean by improving the search result.

Overall, this is really nice improvement for easily finding the content. Thank you.

sandeep-krishnamurthy · 2020-05-15T19:03:04Z

@szha / @leezu - FYI.

ys2843 · 2020-05-15T19:34:20Z

Very nice. Thank you @ys2843 This will be very helpful for the community.
Please update the release manager checklist for changing the defaults.

Should we change anything with algolia (like default version) whenever there is a new release?
Also, for updating the search results, what is the process? What do you mean by improving the search result.

Overall, this is really nice improvement for easily finding the content. Thank you.

Thank you for reviewing. Will update the release manager checklist.

Should we change anything with algolia (like default version) whenever there is a new release?

No, we don't need any change from algolia. We only need to update website code to set the default version. I will document this part.

Also, for updating the search results, what is the process? What do you mean by improving the search result.

To make the search result more relevant and accurate, the process is to update the configuration of DocSearch's web crawler.
Currently the config is not ideal, and the best way to update and test the config is to run the web crawler locally. I have set up the crawler on an ec2 and run it with new config, the data is sent to my test account for review, then I can make adjustment to the config accordingly.

ys2843 · 2020-05-16T00:16:20Z

@mxnet-bot run ci [unix-cpu]

mxnet-bot · 2020-05-16T00:16:25Z

Jenkins CI successfully triggered : [unix-cpu]

ys2843 · 2020-05-16T05:03:17Z

@mxnet-bot run ci [unix-cpu]

mxnet-bot · 2020-05-16T05:03:24Z

Jenkins CI successfully triggered : [unix-cpu]

ys2843 · 2020-05-16T17:39:59Z

@mxnet-bot run ci [unix-cpu]

mxnet-bot · 2020-05-16T17:40:07Z

Jenkins CI successfully triggered : [unix-cpu]

ys2843 · 2020-05-18T22:26:23Z

Should the version dropdown been made consistent with the global version dropdown? I mean at least default to the same version number as used in the global version dropdown?

Not planned to add it to API pages while there is already a search bar on those pages.

Should we replace that search bar? It seems your search implementation is superior?

Good point, I will make the default version the same as the dropdown version.
There is plan to improve the search bar in API sites, but that wasn't discussed in this project. For this project the objective is to add search for main site.

ys2843 · 2020-05-19T03:49:26Z

@mxnet-bot run ci [unix-gpu]

mxnet-bot · 2020-05-19T03:49:31Z

Jenkins CI successfully triggered : [website, unix-cpu]

mxnet-bot · 2020-05-19T03:50:23Z

Jenkins CI successfully triggered : [unix-gpu]

* init global search ui * add hover effect to icon and refactor js * add search bar ui styles * fix search UI's effect on navbar height * add fade in/out effect to search ui and navbar * update search trigger to click and add x button for close * add version select for search * fix version typo * update dropdown * fix hitsperpage reset after change version * fix nav trigger not show * update search border css class name * make dropdown style consistent * global search mobile&tablet UI * adjust mobile search result width * extract global search related styles to a seperate scss * restore formatting to existing code * format & coding style * fix caret height bug * add mobile compatible UI * add license header to js files and update dropdown width * put docsearch css before main to overrides * update search result panel height * dynamically generate version dropdown * use more accurate selector over search result * use vh for height * add comments to scss * move versions to Jekyll global variable * remove redundant version key * make global search default version the same as website version Co-authored-by: Yang Shi <[email protected]>

* Fixed Install page history broken (#18182) * fix install option block history broke * when history goes back, avoid button default css blue outline * use appropriate parameter name * format scss change * Update website version select drop down (#18188) * update version select drop down * align caret * revert scrollable content, add delayed hover effect * bugfix * fix new design doesn't work on mobile # Conflicts: # docs/static_site/src/_includes/get_started/get_started.html * Update website version select drop down (#18188) * update version select drop down * align caret * revert scrollable content, add delayed hover effect * bugfix * fix new design doesn't work on mobile # Conflicts: # docs/static_site/src/_includes/get_started/get_started.html * Fix gluon link missing (#18243) * fix gluon link missing * empty commit to trigger checks * empty commit to trigger checks * fix when clicking version dropdown it jumps to top of the page (#18238) * Website global search feature (#18288) * init global search ui * add hover effect to icon and refactor js * add search bar ui styles * fix search UI's effect on navbar height * add fade in/out effect to search ui and navbar * update search trigger to click and add x button for close * add version select for search * fix version typo * update dropdown * fix hitsperpage reset after change version * fix nav trigger not show * update search border css class name * make dropdown style consistent * global search mobile&tablet UI * adjust mobile search result width * extract global search related styles to a seperate scss * restore formatting to existing code * format & coding style * fix caret height bug * add mobile compatible UI * add license header to js files and update dropdown width * put docsearch css before main to overrides * update search result panel height * dynamically generate version dropdown * use more accurate selector over search result * use vh for height * add comments to scss * move versions to Jekyll global variable * remove redundant version key * make global search default version the same as website version Co-authored-by: Yang Shi <[email protected]> * replace google CDN with JQuery's own CDN (#18369) Co-authored-by: Yang Shi <[email protected]> * Add Developer Guide Docs to MXNet Website (#18474) * init dev guide * move dev guide above FAQ * update format and images * hoist git docs and fix styles * use relative urls * remove useless code block * use consistent url and file name * update heading * add apache license header * init dev guide * move dev guide above FAQ * update format and images * hoist git docs and fix styles * use relative urls * remove useless code block * use consistent url and file name * update heading * add apache license header * update doc - git clone recursive * reviewing the dev guide - proof reading and text edits Co-authored-by: Yang Shi <[email protected]> Co-authored-by: Talia Chopra <[email protected]> * fix contribute page anchor position shifted (#18571) Co-authored-by: Yang Shi <[email protected]> * Clipboard refactor (#18605) * refactor clipboard * make lang getter more extensible * trigger ci * User Feedback Widget (#18639) * user feedback widget implementation * add user feedback widget to python docs site * update margin * add apache license * one more license * turn off feedback widget on python site * update copy * format * add event value field * turn on widget on Python site # Conflicts: # docs/static_site/src/_includes/head.html # docs/static_site/src/assets/main.scss * Fix python micro-site table of content bugs (#18664) * update footer style * add compiled css of footer styles changes * add same style for footer2 * more fix to the toc * Fix all anchor shifts on website (#18674) * use regex that is supported by all browsers (#18811) * 1.7 compatible fix * add jquery fix * Consolidate installation instructions on website and add disclaimer for non-ASF ressources (#18487) * Update website with disclaimer for non-ASF ressources * Integrate Windows instructions to build_from_source.md * Remove master version from selector * Update Download links * Update get_started/download.md per Release Download Page policy # Conflicts: # contrib/clojure-package/README.md # docs/python_docs/python/tutorials/deploy/inference/image_classification_jetson.md # docs/static_site/src/_includes/get_started/get_started.html # docs/static_site/src/_includes/get_started/linux/clojure/gpu.md # docs/static_site/src/_includes/get_started/linux/java/gpu.md # docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md # docs/static_site/src/_includes/get_started/linux/perl/perl.md # docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md # docs/static_site/src/_includes/get_started/linux/python/cpu/pip.md # docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md # docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md # docs/static_site/src/_includes/get_started/linux/python/gpu/pip.md # docs/static_site/src/_includes/get_started/linux/r/gpu.md # docs/static_site/src/_includes/get_started/linux/scala/cpu.md # docs/static_site/src/_includes/get_started/linux/scala/gpu.md # docs/static_site/src/_includes/get_started/macos # docs/static_site/src/_includes/get_started/macos/clojure/cpu.md # docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md # docs/static_site/src/_includes/get_started/macos/perl/perl.md # docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md # docs/static_site/src/_includes/get_started/macos/python/cpu/pip.md # docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md # docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md # docs/static_site/src/_includes/get_started/macos/r/cpu.md # docs/static_site/src/_includes/get_started/macos/scala/cpu.md # docs/static_site/src/_includes/get_started/windows # docs/static_site/src/_includes/get_started/windows/perl/perl.md # docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md # docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md # docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md # docs/static_site/src/_includes/get_started/windows/r/cpu.md # docs/static_site/src/_includes/get_started/windows/r/gpu.md # docs/static_site/src/pages/get_started/build_from_source.md # docs/static_site/src/pages/get_started/download.md # docs/static_site/src/pages/get_started/osx_setup.md # docs/static_site/src/pages/get_started/ubuntu_setup.md # docs/static_site/src/pages/get_started/windows_setup.md * fix broken installation widget - remove empty entries (#18661) * update static files # Conflicts: # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map * update header dropdown default version * fix failed pipeline * cherry pick 1.7 content from master * update version number in image classification tutorial * minor version fix * fix bullet point format bug * Fixed python website double scroller and improve UX (#18845) * make python site header scroll aware and avoid double scroller * add compiled assets * adjust python site second header height * add new line * set focus to main content on DOM load # Conflicts: # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map # docs/python_docs/themes/mx-theme/src/scss/_root.scss * add jekyll base url to enable relative path * fix python micro site header link path * update python site css Co-authored-by: Yang Shi <[email protected]> Co-authored-by: Talia Chopra <[email protected]> Co-authored-by: Leonard Lausen <[email protected]>

* init global search ui * add hover effect to icon and refactor js * add search bar ui styles * fix search UI's effect on navbar height * add fade in/out effect to search ui and navbar * update search trigger to click and add x button for close * add version select for search * fix version typo * update dropdown * fix hitsperpage reset after change version * fix nav trigger not show * update search border css class name * make dropdown style consistent * global search mobile&tablet UI * adjust mobile search result width * extract global search related styles to a seperate scss * restore formatting to existing code * format & coding style * fix caret height bug * add mobile compatible UI * add license header to js files and update dropdown width * put docsearch css before main to overrides * update search result panel height * dynamically generate version dropdown * use more accurate selector over search result * use vh for height * add comments to scss * move versions to Jekyll global variable * remove redundant version key * make global search default version the same as website version Co-authored-by: Yang Shi <[email protected]>

* Add missing license header for md files (#18541) (#19189) Co-authored-by: ciyong <[email protected]> * Fixed Install page history broken (#18182) * fix install option block history broke * when history goes back, avoid button default css blue outline * use appropriate parameter name * format scss change * Update website version select drop down (#18188) * update version select drop down * align caret * revert scrollable content, add delayed hover effect * bugfix * fix new design doesn't work on mobile # Conflicts: # docs/static_site/src/_includes/get_started/get_started.html * Update website version select drop down (#18188) * update version select drop down * align caret * revert scrollable content, add delayed hover effect * bugfix * fix new design doesn't work on mobile # Conflicts: # docs/static_site/src/_includes/get_started/get_started.html * Fix gluon link missing (#18243) * fix gluon link missing * empty commit to trigger checks * empty commit to trigger checks * fix when clicking version dropdown it jumps to top of the page (#18238) * Website global search feature (#18288) * init global search ui * add hover effect to icon and refactor js * add search bar ui styles * fix search UI's effect on navbar height * add fade in/out effect to search ui and navbar * update search trigger to click and add x button for close * add version select for search * fix version typo * update dropdown * fix hitsperpage reset after change version * fix nav trigger not show * update search border css class name * make dropdown style consistent * global search mobile&tablet UI * adjust mobile search result width * extract global search related styles to a seperate scss * restore formatting to existing code * format & coding style * fix caret height bug * add mobile compatible UI * add license header to js files and update dropdown width * put docsearch css before main to overrides * update search result panel height * dynamically generate version dropdown * use more accurate selector over search result * use vh for height * add comments to scss * move versions to Jekyll global variable * remove redundant version key * make global search default version the same as website version Co-authored-by: Yang Shi <[email protected]> * replace google CDN with JQuery's own CDN (#18369) Co-authored-by: Yang Shi <[email protected]> * Add Developer Guide Docs to MXNet Website (#18474) * init dev guide * move dev guide above FAQ * update format and images * hoist git docs and fix styles * use relative urls * remove useless code block * use consistent url and file name * update heading * add apache license header * init dev guide * move dev guide above FAQ * update format and images * hoist git docs and fix styles * use relative urls * remove useless code block * use consistent url and file name * update heading * add apache license header * update doc - git clone recursive * reviewing the dev guide - proof reading and text edits Co-authored-by: Yang Shi <[email protected]> Co-authored-by: Talia Chopra <[email protected]> * fix contribute page anchor position shifted (#18571) Co-authored-by: Yang Shi <[email protected]> * Clipboard refactor (#18605) * refactor clipboard * make lang getter more extensible * trigger ci * User Feedback Widget (#18639) * user feedback widget implementation * add user feedback widget to python docs site * update margin * add apache license * one more license * turn off feedback widget on python site * update copy * format * add event value field * turn on widget on Python site # Conflicts: # docs/static_site/src/_includes/head.html # docs/static_site/src/assets/main.scss * Fix python micro-site table of content bugs (#18664) * update footer style * add compiled css of footer styles changes * add same style for footer2 * more fix to the toc * Fix all anchor shifts on website (#18674) * use regex that is supported by all browsers (#18811) * 1.7 compatible fix * add jquery fix * Consolidate installation instructions on website and add disclaimer for non-ASF ressources (#18487) * Update website with disclaimer for non-ASF ressources * Integrate Windows instructions to build_from_source.md * Remove master version from selector * Update Download links * Update get_started/download.md per Release Download Page policy # Conflicts: # contrib/clojure-package/README.md # docs/python_docs/python/tutorials/deploy/inference/image_classification_jetson.md # docs/static_site/src/_includes/get_started/get_started.html # docs/static_site/src/_includes/get_started/linux/clojure/gpu.md # docs/static_site/src/_includes/get_started/linux/java/gpu.md # docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md # docs/static_site/src/_includes/get_started/linux/perl/perl.md # docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md # docs/static_site/src/_includes/get_started/linux/python/cpu/pip.md # docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md # docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md # docs/static_site/src/_includes/get_started/linux/python/gpu/pip.md # docs/static_site/src/_includes/get_started/linux/r/gpu.md # docs/static_site/src/_includes/get_started/linux/scala/cpu.md # docs/static_site/src/_includes/get_started/linux/scala/gpu.md # docs/static_site/src/_includes/get_started/macos # docs/static_site/src/_includes/get_started/macos/clojure/cpu.md # docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md # docs/static_site/src/_includes/get_started/macos/perl/perl.md # docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md # docs/static_site/src/_includes/get_started/macos/python/cpu/pip.md # docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md # docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md # docs/static_site/src/_includes/get_started/macos/r/cpu.md # docs/static_site/src/_includes/get_started/macos/scala/cpu.md # docs/static_site/src/_includes/get_started/windows # docs/static_site/src/_includes/get_started/windows/perl/perl.md # docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md # docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md # docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md # docs/static_site/src/_includes/get_started/windows/r/cpu.md # docs/static_site/src/_includes/get_started/windows/r/gpu.md # docs/static_site/src/pages/get_started/build_from_source.md # docs/static_site/src/pages/get_started/download.md # docs/static_site/src/pages/get_started/osx_setup.md # docs/static_site/src/pages/get_started/ubuntu_setup.md # docs/static_site/src/pages/get_started/windows_setup.md * fix broken installation widget - remove empty entries (#18661) * update static files # Conflicts: # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map * update header dropdown default version * fix failed pipeline * cherry pick 1.7 content from master * update version number in image classification tutorial * minor version fix * fix bullet point format bug * Fixed python website double scroller and improve UX (#18845) * make python site header scroll aware and avoid double scroller * add compiled assets * adjust python site second header height * add new line * set focus to main content on DOM load # Conflicts: # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map # docs/python_docs/themes/mx-theme/src/scss/_root.scss * add jekyll base url to enable relative path * fix python micro site header link path * update python site css Co-authored-by: Sheng Zha <[email protected]> Co-authored-by: ciyong <[email protected]> Co-authored-by: Yang Shi <[email protected]> Co-authored-by: Talia Chopra <[email protected]> Co-authored-by: Leonard Lausen <[email protected]>

* Fixed Install page history broken (#18182) * fix install option block history broke * when history goes back, avoid button default css blue outline * use appropriate parameter name * format scss change * Update website version select drop down (#18188) * update version select drop down * align caret * revert scrollable content, add delayed hover effect * bugfix * fix new design doesn't work on mobile # Conflicts: # docs/static_site/src/_includes/get_started/get_started.html * Update website version select drop down (#18188) * update version select drop down * align caret * revert scrollable content, add delayed hover effect * bugfix * fix new design doesn't work on mobile # Conflicts: # docs/static_site/src/_includes/get_started/get_started.html * Fix gluon link missing (#18243) * fix gluon link missing * empty commit to trigger checks * empty commit to trigger checks * fix when clicking version dropdown it jumps to top of the page (#18238) * Website global search feature (#18288) * init global search ui * add hover effect to icon and refactor js * add search bar ui styles * fix search UI's effect on navbar height * add fade in/out effect to search ui and navbar * update search trigger to click and add x button for close * add version select for search * fix version typo * update dropdown * fix hitsperpage reset after change version * fix nav trigger not show * update search border css class name * make dropdown style consistent * global search mobile&tablet UI * adjust mobile search result width * extract global search related styles to a seperate scss * restore formatting to existing code * format & coding style * fix caret height bug * add mobile compatible UI * add license header to js files and update dropdown width * put docsearch css before main to overrides * update search result panel height * dynamically generate version dropdown * use more accurate selector over search result * use vh for height * add comments to scss * move versions to Jekyll global variable * remove redundant version key * make global search default version the same as website version Co-authored-by: Yang Shi <[email protected]> * replace google CDN with JQuery's own CDN (#18369) Co-authored-by: Yang Shi <[email protected]> * Add Developer Guide Docs to MXNet Website (#18474) * init dev guide * move dev guide above FAQ * update format and images * hoist git docs and fix styles * use relative urls * remove useless code block * use consistent url and file name * update heading * add apache license header * init dev guide * move dev guide above FAQ * update format and images * hoist git docs and fix styles * use relative urls * remove useless code block * use consistent url and file name * update heading * add apache license header * update doc - git clone recursive * reviewing the dev guide - proof reading and text edits Co-authored-by: Yang Shi <[email protected]> Co-authored-by: Talia Chopra <[email protected]> * fix contribute page anchor position shifted (#18571) Co-authored-by: Yang Shi <[email protected]> * Clipboard refactor (#18605) * refactor clipboard * make lang getter more extensible * trigger ci * User Feedback Widget (#18639) * user feedback widget implementation * add user feedback widget to python docs site * update margin * add apache license * one more license * turn off feedback widget on python site * update copy * format * add event value field * turn on widget on Python site # Conflicts: # docs/static_site/src/_includes/head.html # docs/static_site/src/assets/main.scss * Fix python micro-site table of content bugs (#18664) * update footer style * add compiled css of footer styles changes * add same style for footer2 * more fix to the toc * Fix all anchor shifts on website (#18674) * use regex that is supported by all browsers (#18811) * 1.7 compatible fix * add jquery fix * Consolidate installation instructions on website and add disclaimer for non-ASF ressources (#18487) * Update website with disclaimer for non-ASF ressources * Integrate Windows instructions to build_from_source.md * Remove master version from selector * Update Download links * Update get_started/download.md per Release Download Page policy # Conflicts: # contrib/clojure-package/README.md # docs/python_docs/python/tutorials/deploy/inference/image_classification_jetson.md # docs/static_site/src/_includes/get_started/get_started.html # docs/static_site/src/_includes/get_started/linux/clojure/gpu.md # docs/static_site/src/_includes/get_started/linux/java/gpu.md # docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md # docs/static_site/src/_includes/get_started/linux/perl/perl.md # docs/static_site/src/_includes/get_started/linux/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md # docs/static_site/src/_includes/get_started/linux/python/cpu/pip.md # docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md # docs/static_site/src/_includes/get_started/linux/python/gpu/docker.md # docs/static_site/src/_includes/get_started/linux/python/gpu/pip.md # docs/static_site/src/_includes/get_started/linux/r/gpu.md # docs/static_site/src/_includes/get_started/linux/scala/cpu.md # docs/static_site/src/_includes/get_started/linux/scala/gpu.md # docs/static_site/src/_includes/get_started/macos # docs/static_site/src/_includes/get_started/macos/clojure/cpu.md # docs/static_site/src/_includes/get_started/macos/julia/build-from-source.md # docs/static_site/src/_includes/get_started/macos/perl/perl.md # docs/static_site/src/_includes/get_started/macos/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md # docs/static_site/src/_includes/get_started/macos/python/cpu/pip.md # docs/static_site/src/_includes/get_started/macos/python/gpu/build-from-source.md # docs/static_site/src/_includes/get_started/macos/python/gpu/pip_docker.md # docs/static_site/src/_includes/get_started/macos/r/cpu.md # docs/static_site/src/_includes/get_started/macos/scala/cpu.md # docs/static_site/src/_includes/get_started/windows # docs/static_site/src/_includes/get_started/windows/perl/perl.md # docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md # docs/static_site/src/_includes/get_started/windows/python/cpu/docker.md # docs/static_site/src/_includes/get_started/windows/python/cpu/pip.md # docs/static_site/src/_includes/get_started/windows/python/gpu/pip.md # docs/static_site/src/_includes/get_started/windows/r/cpu.md # docs/static_site/src/_includes/get_started/windows/r/gpu.md # docs/static_site/src/pages/get_started/build_from_source.md # docs/static_site/src/pages/get_started/download.md # docs/static_site/src/pages/get_started/osx_setup.md # docs/static_site/src/pages/get_started/ubuntu_setup.md # docs/static_site/src/pages/get_started/windows_setup.md * fix broken installation widget - remove empty entries (#18661) * update static files # Conflicts: # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map * update header dropdown default version * fix failed pipeline * cherry pick 1.7 content from master * update version number in image classification tutorial * minor version fix * fix bullet point format bug * Fixed python website double scroller and improve UX (#18845) * make python site header scroll aware and avoid double scroller * add compiled assets * adjust python site second header height * add new line * set focus to main content on DOM load # Conflicts: # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js # docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map # docs/python_docs/themes/mx-theme/src/scss/_root.scss * add jekyll base url to enable relative path * fix python micro site header link path * update python site css Co-authored-by: Yang Shi <[email protected]> Co-authored-by: Talia Chopra <[email protected]> Co-authored-by: Leonard Lausen <[email protected]>

ys2843 requested review from aaronmarkham and szha as code owners May 12, 2020 06:29

lanking520 added the pr-work-in-progress PR is still work in progress label May 12, 2020

ys2843 force-pushed the website-global-search-feature branch 2 times, most recently from 318755e to a797c4a Compare May 13, 2020 05:23

marcoabreu reviewed May 13, 2020

View reviewed changes

docs/static_site/src/_includes/header.html Outdated Show resolved Hide resolved

ys2843 force-pushed the website-global-search-feature branch from 398a3a1 to 67804b0 Compare May 13, 2020 18:48

lanking520 added pr-awaiting-review PR is waiting for code review and removed pr-work-in-progress PR is still work in progress labels May 14, 2020

ys2843 force-pushed the website-global-search-feature branch from 939a6ee to d7a45e2 Compare May 14, 2020 21:52

aaronmarkham approved these changes May 14, 2020

View reviewed changes

docs/static_site/src/_includes/head.html Show resolved Hide resolved

docs/static_site/src/assets/js/globalSearch.js Outdated Show resolved Hide resolved

sandeep-krishnamurthy approved these changes May 15, 2020

View reviewed changes

ys2843 force-pushed the website-global-search-feature branch from 8d2b4a9 to 55eb9bd Compare May 15, 2020 19:37

ys2843 requested a review from marcoabreu May 15, 2020 21:10

ys2843 force-pushed the website-global-search-feature branch from 55eb9bd to 622ddaa Compare May 16, 2020 01:23

ys2843 added 12 commits May 18, 2020 15:19

fix caret height bug

aa0430f

add mobile compatible UI

cff1da4

add license header to js files and update dropdown width

5164f6f

put docsearch css before main to overrides

60d0715

update search result panel height

4d97ac8

dynamically generate version dropdown

e588283

use more accurate selector over search result

20628b4

use vh for height

d58ce1f

add comments to scss

8ca1c10

move versions to Jekyll global variable

34709c4

remove redundant version key

4693954

make global search default version the same as website version

f038f5e

ys2843 force-pushed the website-global-search-feature branch from 4498db6 to f038f5e Compare May 18, 2020 22:20

aaronmarkham merged commit 14c24a5 into apache:master May 19, 2020

ys2843 deleted the website-global-search-feature branch May 19, 2020 18:28

This was referenced May 27, 2020

[website] global search feature needed #16323

Closed

Dynamically Generate Version Dropdown #18473

Merged

ys2843 mentioned this pull request Jun 19, 2020

Can't press down arrow in search results dropdown on https://mxnet.incubator.apache.org/ #10402

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Website global search feature #18288

Website global search feature #18288

ys2843 commented May 12, 2020 •

edited

Loading

mxnet-bot commented May 12, 2020

ys2843 commented May 12, 2020 •

edited

Loading

ChaiBapchya commented May 14, 2020 •

edited

Loading

ys2843 commented May 14, 2020 •

edited

Loading

aaronmarkham left a comment

ys2843 commented May 15, 2020 •

edited

Loading

sandeep-krishnamurthy commented May 15, 2020

mxnet-bot commented May 15, 2020

sandeep-krishnamurthy left a comment

sandeep-krishnamurthy commented May 15, 2020

ys2843 commented May 15, 2020 •

edited

Loading

ys2843 commented May 16, 2020

mxnet-bot commented May 16, 2020

ys2843 commented May 16, 2020

mxnet-bot commented May 16, 2020

ys2843 commented May 16, 2020

mxnet-bot commented May 16, 2020

ys2843 commented May 18, 2020

ys2843 commented May 19, 2020 •

edited

Loading

mxnet-bot commented May 19, 2020

mxnet-bot commented May 19, 2020

Website global search feature #18288

Website global search feature #18288

Conversation

ys2843 commented May 12, 2020 • edited Loading

Description

Checklist

Essentials

Changes

Comments

mxnet-bot commented May 12, 2020

ys2843 commented May 12, 2020 • edited Loading

ChaiBapchya commented May 14, 2020 • edited Loading

ys2843 commented May 14, 2020 • edited Loading

aaronmarkham left a comment

Choose a reason for hiding this comment

ys2843 commented May 15, 2020 • edited Loading

sandeep-krishnamurthy commented May 15, 2020

mxnet-bot commented May 15, 2020

sandeep-krishnamurthy left a comment

Choose a reason for hiding this comment

sandeep-krishnamurthy commented May 15, 2020

ys2843 commented May 15, 2020 • edited Loading

ys2843 commented May 16, 2020

mxnet-bot commented May 16, 2020

ys2843 commented May 16, 2020

mxnet-bot commented May 16, 2020

ys2843 commented May 16, 2020

mxnet-bot commented May 16, 2020

ys2843 commented May 18, 2020

ys2843 commented May 19, 2020 • edited Loading

mxnet-bot commented May 19, 2020

mxnet-bot commented May 19, 2020

ys2843 commented May 12, 2020 •

edited

Loading

ys2843 commented May 12, 2020 •

edited

Loading

ChaiBapchya commented May 14, 2020 •

edited

Loading

ys2843 commented May 14, 2020 •

edited

Loading

ys2843 commented May 15, 2020 •

edited

Loading

ys2843 commented May 15, 2020 •

edited

Loading

ys2843 commented May 19, 2020 •

edited

Loading