Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[DOC] V1.7 website patch #19102

Merged
merged 29 commits into from
Sep 24, 2020
Merged

[DOC] V1.7 website patch #19102

merged 29 commits into from
Sep 24, 2020

Conversation

ys2843
Copy link
Contributor

@ys2843 ys2843 commented Sep 9, 2020 •
edited
Loading

Description

1.7 release website patch

Checklist

Essentials

  • PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage
  • Code is well-documented

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

Yang Shi and others added 17 commits September 7, 2020 20:21
@ys2843
Fixed Install page history broken (apache#18182)
2f25012 
* fix install option block history broke

* when history goes back, avoid button default css blue outline

* use appropriate parameter name

* format scss change
@ys2843
Update website version select drop down (apache#18188)
3d125a6 
* 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
@ys2843
Update website version select drop down (apache#18188)
ea440b9 
* 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
@ys2843
Fix gluon link missing (apache#18243)
b92871b 
* fix gluon link missing

* empty commit to trigger checks

* empty commit to trigger checks
@ys2843
fix when clicking version dropdown it jumps to top of the page (apach…
172f44b 
…e#18238)
@ys2843
Website global search feature (apache#18288)
e012f0c 
* 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]>
@ys2843
replace google CDN with JQuery's own CDN (apache#18369)
3ae3d04 
Co-authored-by: Yang Shi <[email protected]>
@ys2843
Add Developer Guide Docs to MXNet Website (apache#18474)
5a4f78f 
* 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]>
@ys2843
fix contribute page anchor position shifted (apache#18571)
eb7bef2 
Co-authored-by: Yang Shi <[email protected]>
@ys2843
Clipboard refactor (apache#18605)
180784e 
* refactor clipboard

* make lang getter more extensible

* trigger ci
@ys2843
User Feedback Widget (apache#18639)
566e220 
* 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
@ys2843
Fix python micro-site table of content bugs (apache#18664)
0a21657 
* update footer style

* add compiled css of footer styles changes

* add same style for footer2

* more fix to the toc
@ys2843
Fix all anchor shifts on website (apache#18674)
f288050
@ys2843
use regex that is supported by all browsers (apache#18811)
c92f3ab
@ys2843
1.7 compatible fix
afea0b7
@ys2843
add jquery fix
abad4dd
@leezu @ys2843
Consolidate installation instructions on website and add disclaimer f…
99b7878 
…or non-ASF ressources (apache#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
@mxnet-bot
Copy link

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: [website, sanity, unix-gpu, windows-cpu, edge, clang, centos-cpu, centos-gpu, windows-gpu, unix-cpu, miscellaneous]

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
fix broken installation widget - remove empty entries (apache#18661)
2d35774
@ys2843
update static files
199de98 
# 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
@ys2843
update header dropdown default version
8e4941a
@ys2843
fix failed pipeline
200b054
leezu
leezu reviewed Sep 9, 2020
View reviewed changes
Copy link
Contributor

@leezu leezu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. Please see the 2 questions below

docs/python_docs/python/tutorials/deploy/inference/image_classification_jetson.md Outdated Show resolved Hide resolved
docs/static_site/src/pages/get_started/download.md Outdated Show resolved Hide resolved
@szha szha mentioned this pull request Sep 10, 2020
Closed
@ys2843
Fixed python website double scroller and improve UX (apache#18845)
909b172 
* 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
@ys2843
add jekyll base url to enable relative path
ac80704
@ys2843
fix python micro site header link path
e2f45ba
@ys2843
update python site css
0bf1843
@ys2843 ys2843 changed the title V1.7 website patch [DOC] V1.7 website patch Sep 11, 2020
@access2rohit
Copy link
Contributor

@ys2843 can you get approval on this PR to get it merged ?

@mxnet-bot
Copy link

Jenkins CI successfully triggered : [centos-gpu, unix-gpu, unix-cpu]

@ys2843
Copy link
Contributor Author

ys2843 commented Sep 23, 2020 •
edited
Loading

@mxnet-bot run ci [unix-gpu]

@mxnet-bot
Copy link

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

@ys2843 ys2843 mentioned this pull request Sep 23, 2020
Merged
5 tasks
@apache apache deleted a comment from mxnet-bot Sep 24, 2020
@apache apache deleted a comment from mxnet-bot Sep 24, 2020
@mxnet-bot
Copy link

Jenkins CI successfully triggered : [unix-gpu]

@szha szha merged commit 7efb5df into apache:v1.7.x Sep 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mseth10 mseth10 mseth10 left review comments

@leezu leezu leezu left review comments

@aaronmarkham aaronmarkham Awaiting requested review from aaronmarkham aaronmarkham is a code owner

@szha szha Awaiting requested review from szha szha is a code owner

@marcoabreu marcoabreu Awaiting requested review from marcoabreu marcoabreu is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ys2843 @mxnet-bot @access2rohit @leezu @mseth10 @szha