https://github.com/uwrit/infra-docs
https://github.com/uwrit/infra-docs
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/uwrit/infra-docs
- Owner: uwrit
- Created: 2021-01-06T00:22:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T18:27:04.000Z (about 2 years ago)
- Last Synced: 2025-04-02T21:42:37.626Z (about 1 year ago)
- Language: HTML
- Size: 2.28 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Installation setup
`brew install mkdocs`
`git clone git@github.com:uwrit/infra-docs.git`
`cd infra-docs`
`mkdocs serve`
# alternative Native Python setup
check Python is greater than 3
```
$ python -V
Python 3.8.7
```
then setup a virtual environment (called venv here) and install mkdocs...
```
$ python -m venv venv
$ source ./venv/bin/activate
$ pip install --upgrade pip
$ pip install mkdocs
$ mkdocs serve
```
# Updating changes to onboard.rit.uw.edu
1. Change files as needed on any branch
2. Merge changes to master
3. Run command `mkdocs gh-deploy`
onboard.rit.uw.edu should update automatically
Note: keep CNAME file in docs/CNAME
Mkdocs GitHub pages deployment reference: https://www.mkdocs.org/user-guide/deploying-your-docs/