All forms of feedback are welcome through issues - please follow the pre-defined templates where applicable.
Pull requests (PRs) to this repo require review and approval by the Azure Machine Learning team to merge. Please follow the pre-defined template and read all relevant sections below.
Make PR's against the
- When a PR arrives against
mainGitHub actions (deploy) will test the build is successful
- When the PR is merged the change will be automatically deployed to
gh-pagesbranch (and the webpage will be updated)
99% of contributions should only need the following:
- Add markdown files to the
- Update the
sidebar.jsfile to add a page to the sidebar
- Put any images in
website/docs/cheatsheets/<path-to-cheat-sheet-directory>/img/and refer to them like this:
If you need to do anything more than adding a new page to the sidebar (e.g. modify the nav bar) then please refer to the Docusaurus 2 documentation.
Run local server while developing:cd websiteyarn start
See Docusaurus instructions here for more details.