wenxwei / azureml-web

Azure Machine Learning website

Azure ML Cheat Sheet

Website is available here: https://azure.github.io/azureml-web/

This website is built using Docusaurus 2, a modern static website generator.

Contributions

Make PR's against the main branch

git clone [email protected]:Azure/azureml-web.git
cd azureml-examples
git checkout -b user/contrib

• When a PR arrives against main GitHub actions (deploy-website) will test the build is successful
• When the PR is merged the change will be automatically deployed to gh-pages branch (and the webpage will be updated)

99% of contributions should only need the following:

• Add markdown files to the website/docs folder
• Update the sidebar.js file to add a page to the sidebar
• Put any images in website/docs/img/ and refer to them like this: ![](img/create-compute.png)

If you need to do anything more than adding a new page to the sidebar (e.g. modify the nav bar) then a) please refer to Docusaurus 2.

Previewing Changes Locally

• Install npm and yarn: see docusaurus2 webpage

• First time Docusaurus2 installation

  cd website
  npm install

• Run local server while developing:

  cd website
  yarn start

Deployment

This repo has GitHub actions in place that automate deployment by watching the website branch. If you are interested in how deployment works then read on!

GitHub Actions

We use GitHub actions to automate deployment. Set up was as follows:

• Generated new SSH key
  • NB. Since there was an existing ssh key tied the repo a new key was generated (in a different location) /tmp/.ssh/id_rsa
• Add public key to repo's deploy key
  • NB. Allow write access
• Add private key as GitHub secret
  • We use repo-level (not org level) secret
  • Secret is named GH_PAGES_DEPLOY
  • xclip -sel clip < /tmp/.ssh/id_rsa

Manual

It is possible to make manual deployments without use of the GitHub action above.

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.