Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate content from GitHub source to GitHub pages #5053

Merged
merged 21 commits into from
Oct 12, 2020

Conversation

natke
Copy link
Contributor

@natke natke commented Sep 3, 2020

Description: Migration of ONNX Runtime documentation to GitHub pages site

Motivation and Context

  • Present documentation in discoverable and navigable format
  • Improve usability of docs
  • Improve docs content
  • Enable analytics on all docs pages

Docs are staged here: https://natke.github.io/docs/

This PR does not include, which will be included in future improvements:

  • Quickstart for ONNX Runtime
  • Refactor build from source instructions
  • Add article on docker
  • Scenario based samples
  • Split out install guide into different languages / execution providers
  • Update training docs with new API
  • Incorporate auto generated content

assets/images/ONNX-Runtime-logo.svg Outdated Show resolved Hide resolved
docs/get-started/index.md Outdated Show resolved Hide resolved
docs/get-started/index.md Outdated Show resolved Hide resolved
docs/reference/api/nodejs_README.md Outdated Show resolved Hide resolved
docs/resources/graph-optimizations.md Outdated Show resolved Hide resolved
docs/how-to/index.md Outdated Show resolved Hide resolved
docs/how-to/tune-performance.md Outdated Show resolved Hide resolved
docs/how-to/tune-performance.md Outdated Show resolved Hide resolved
docs/tutorials/samples_catalog.md Show resolved Hide resolved
docs/tutorials/mnist_cpp.md Outdated Show resolved Hide resolved
docs/resources/compatibility.md Outdated Show resolved Hide resolved
docs/get-started/install.md Show resolved Hide resolved
docs/get-started/install.md Show resolved Hide resolved
@natke
Copy link
Contributor Author

natke commented Sep 30, 2020

@faxu @prasanthpul I've updated with all of your comments and re-staged here: https://natke.github.io/docs/

I am running and full link check and fixing the remaining broken links.

@snnn
Copy link
Member

snnn commented Oct 1, 2020

Hi @natke, could you please help address the following concern in #5347 ?

the instruction wget https://cmake.org/files/v3.13/cmake-3.16.1.tar.gz; is not working as the version 3.13 and 3.16.1 are in different folders on the remote server

@natke natke marked this pull request as ready for review October 5, 2020 22:13
@prasanthpul prasanthpul self-requested a review October 7, 2020 22:48
@faxu faxu merged commit 15291ab into microsoft:gh-pages Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants