Merge pull request #314 from tokk-nv/main

VLLM Workshop Tutorial added (for GTC DC)

Author: tokk-nv

.gitlab-ci.yml

@@ -1,14 +1,16 @@
 image: python:latest
+
 pages:
   stage: deploy
   only:
-    - master 
+    - master
     - main
   script:
     - pip install mkdocs-material
+    - pip install mkdocs-redirects
     - mkdocs build --site-dir public
   artifacts:
     paths:
       - public
   tags:
-    - pages
+    - pages

README.md

@@ -11,7 +11,9 @@ The auto generated documentation is hosted on the following, using their CI/CD f
 
 ## How to use this repo locally
 
-### MkDocs: Initial setup
+### Option 1: Docker Setup (Linux systems with Docker)
+
+#### Initial setup
 
 https://squidfunk.github.io/mkdocs-material/getting-started/
 
@@ -20,12 +22,39 @@ sudo apt install -y docker.io
 sudo docker pull squidfunk/mkdocs-material
 ```
 
-### Mkdocs: Start development server on http://localhost:8000
+#### Start development server on http://localhost:8000
 
 ```bash
 docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
 ```
 
+### Option 2: Native Python Setup (Recommended for Windows)
+
+#### Initial setup
+
+1. **Install Python 3.8+ and pip** (if not already installed):
+   - Windows: Download from [python.org](https://www.python.org/downloads/) or use Microsoft Store
+
+2. **Install MkDocs Material and dependencies**:
+   ```bash
+   pip install mkdocs-material
+   pip install mkdocs-redirects
+   pip install beautifulsoup4
+   pip install lxml
+   ```
+
+#### Start development server on http://localhost:8000
+
+```bash
+mkdocs serve
+```
+
+#### Build the site
+
+```bash
+mkdocs build
+```
+
 ### Test the post-processing
 
 ```bash
@@ -39,6 +68,19 @@ livereload ./site_postprocessed
 
 ## Troubleshooting
 
-> If you get "docker: Got permission denied while trying to connect to the Docker daemon socket at ..." error, 
+### Native Python Setup Issues
+
+**Windows:**
+- If `mkdocs` command is not found, ensure Python Scripts directory is in your PATH
+- Use `python -m mkdocs serve` if the direct command doesn't work
+- For corporate networks, you may need to use pip with proxy: `pip install --proxy http://proxy:port package-name`
+
+**Jetson:**
+- If you get permission errors, use `pip install --user` to install packages locally
+- Ensure you have sufficient disk space for the Python packages
+
+### Docker Setup Issues
+
+> If you get "docker: Got permission denied while trying to connect to the Docker daemon socket at ..." error,
 > issue `sudo usermod -aG docker $USER; newgrp docker` to get around with the issue.