infra: update tools (vllm-project#501)

Signed-off-by: yuluo-yx <[email protected]>
Signed-off-by: Huamin Chen <[email protected]>

Author: yuluo-yx

tools/make/docs.mk

@@ -23,3 +23,12 @@ docs-serve: docs-build ## Serve built documentation website
 docs-clean: ## Clean documentation build artifacts
 	@$(LOG_TARGET)
 	cd website && npm run clear
+
+docs-lint: ## Lint documentation website source files
+	@$(LOG_TARGET)
+	cd website && npm run lint
+
+docs-lint-fix: ## Fix lint issues in documentation website source files
+	@$(LOG_TARGET)
+	cd website && npm run lint:fix
+

tools/make/pre-commit.mk

@@ -3,9 +3,11 @@
 PRECOMMIT_CONTAINER := ghcr.io/vllm-project/semantic-router/precommit:latest
 
 precommit-install: ## Install pre-commit Python package
+precommit-install:
 	pip install pre-commit
 
 precommit-check: ## Run pre-commit checks on all relevant files
+precommit-check:
 	@FILES=$$(find . -type f \( -name "*.go" -o -name "*.rs" -o -name "*.py" -o -name "*.js" -o -name "*.md" -o -name "*.yaml" -o -name "*.yml" \) \
 		! -path "./target/*" \
 		! -path "./candle-binding/target/*" \
@@ -33,6 +35,7 @@ precommit-check: ## Run pre-commit checks on all relevant files
 #     bash
 # and then, run `pre-commit install && pre-commit run --all-files` command
 precommit-local: ## Run pre-commit hooks in a Docker/Podman container
+precommit-local:
 	@if command -v docker > /dev/null 2>&1; then \
 		CONTAINER_CMD=docker; \
 	elif command -v podman > /dev/null 2>&1; then \

website/src/pages/community/contributing.tsx

@@ -139,60 +139,101 @@ const Contributing: React.FC = () => {
               <div className={styles.stepNumberTips}>
                 <p>1. If the precommit check fails, don't worry. You can also get more information by executing "make help". </p>
                 <p>2. For the pip installation tool, we recommend that you use venv for installation.</p>
-                <p>3. You can also directly submit the PR and let GitHub CI test it for you, but this will take a lot of time!</p>
+                <p>3. We recommend installing pre-commit through Python's virtual environment.</p>
+                <p>4. You can also directly submit the PR and let GitHub CI test it for you, but this will take a lot of time!</p>
               </div>
 
               <div className={styles.steps}>
                 <div className={styles.step}>
                   <span className={styles.stepNumber}>1</span>
                   <div>
                     <h4>Install precommit</h4>
-                    <p>Run pip install --user precommit</p>
+                    <p>
+                      Run
+                      <code>pip install --user pre-commit</code>
+                    </p>
                   </div>
                 </div>
                 <div className={styles.step}>
                   <span className={styles.stepNumber}>2</span>
                   <div>
                     <h4>Install check tools</h4>
                     <div className={styles.stepNumberTips}>
-                      <p>Markdown: npm install -g markdownlint-cli</p>
-                      <p>Yaml: pip install --user yamllint</p>
-                      <p>CodeSpell: pip install --user codespell</p>
-                      <p>JavaScript: cd website && npm lint</p>
+                      <p>
+                        1. Markdown:
+                        <code>npm install -g markdownlint-cli</code>
+                      </p>
+                      <p>
+                        2. Yaml:
+                        <code>pip install --user yamllint</code>
+                      </p>
+                      <p>
+                        3. CodeSpell:
+                        <code>pip install --user codespell</code>
+                      </p>
+                      <p>
+                        4. JavaScript:
+                        <code>cd website && npm lint</code>
+                      </p>
+                      <p>
+                        5. Shell: take Mac as an example, execute
+                        <code>brew install shellcheck</code>
+                      </p>
                     </div>
                   </div>
                 </div>
                 <div className={styles.step}>
                   <span className={styles.stepNumber}>3</span>
                   <div>
                     <h4>Install precommit to git</h4>
-                    <p>Run pre-commit install, then pre-commit installed at .git/hooks/pre-commit</p>
+                    <p>
+                      Run
+                      <code>pre-commit install</code>
+                      , then pre-commit installed at
+                      <code>.git/hooks/pre-commit</code>
+                    </p>
                   </div>
                 </div>
                 <div className={styles.step}>
                   <span className={styles.stepNumber}>4</span>
                   <div>
                     <h4>Run</h4>
-                    <p>Run make precommit-check to check.</p>
+                    <p>
+                      Run
+                      <code>make precommit-check</code>
+                      {' '}
+                      to check.
+                    </p>
                   </div>
                 </div>
 
                 <hr />
 
                 <h3>Docker/Podman</h3>
                 <p>From the above local running method, it can be seen that the process is very troublesome and complicated. Therefore, we have provided running methods based on Docker or Podman. There is no need to install various dependent software; all you need is a container runtime.</p>
+
+                <h4>Some Tips: </h4>
+                <div className={styles.stepNumberTips}>
+                  <p>
+                    Although Docker can help avoid installing too many detection tools locally, this does not mean that it will be automatically executed during the commit process. Therefore, when committing, you can use
+                    <code>git commit -s -m -n</code>
+                    {' '}
+                    to skip the detection.
+                    {' '}
+                  </p>
+                </div>
                 <div className={styles.step}>
                   <span className={styles.stepNumber}>1</span>
                   <div>
                     <h4>Make sure Docker/Podman is installed</h4>
-                    <p>docker --version</p>
+                    <p><code>docker --version</code></p>
                   </div>
                 </div>
                 <div className={styles.step}>
                   <span className={styles.stepNumber}>2</span>
                   <div>
                     <h4>Run precommit by Docker/Podman</h4>
-                    <p>make precommit-local</p>
+                    <p><code>make precommit-local</code></p>
                   </div>
                 </div>
                 <div>