docs: Using Descope with the Tyk Portal and Gateway #10057
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Validate Documentation | |
| on: | |
| pull_request: | |
| permissions: | |
| contents: read | |
| jobs: | |
| validate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| - name: Set up Python | |
| uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 | |
| with: | |
| python-version: '3.9' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade 'pip>=23.0,<25' | |
| pip install 'requests>=2.31.0,<3' | |
| pip install 'pyyaml>=6.0,<7' | |
| - name: Validate documentation | |
| run: | | |
| echo "🔍 Running documentation validation..." | |
| python scripts/validate_mintlify_docs.py . --validate-redirects --verbose | |
| - name: Check anchor fragments | |
| run: | | |
| echo "⚓ Checking internal anchor fragments..." | |
| python scripts/validate_mintlify_docs.py . --check-anchors --links-only | |
| - name: Check for links that redirect | |
| run: | | |
| echo "↪️ Checking for internal links that hit a 3xx redirect..." | |
| python scripts/validate_mintlify_docs.py . --check-redirecting-links --links-only | |
| - name: Check for insecure first-party links | |
| run: | | |
| echo "🔒 Checking for insecure http:// links to tyk.io..." | |
| python scripts/validate_mintlify_docs.py . --check-insecure-links --links-only | |
| - name: Check for multiple H1 tags | |
| run: | | |
| echo "🔠 Checking for pages with multiple H1 tags..." | |
| python scripts/validate_mintlify_docs.py . --check-multiple-h1 --links-only | |
| - name: Check for relative markdown links | |
| run: | | |
| echo "Checking for relative markdown links (must start with /)..." | |
| RELATIVE_LINKS=$(grep -rEn --include="*.md" --include="*.mdx" '\]\([^/\)\s#][^)]*\)' . \ | |
| | grep -vE '\]\((https?://|mailto:|ftp://|\{|<mailto)' \ | |
| | grep -v '{/\*' \ | |
| | grep -v '`\[' \ | |
| | grep -v "'\[" \ | |
| || true) | |
| if [ -n "$RELATIVE_LINKS" ]; then | |
| echo "Found relative markdown links that should use absolute paths (starting with /):" | |
| echo "$RELATIVE_LINKS" | |
| exit 1 | |
| fi | |
| echo "All internal markdown links use absolute paths." | |
| - name: Validation complete | |
| if: success() | |
| run: | | |
| echo "✅ Documentation validation passed!" | |
| echo "All links, images, navigation, redirects, and anchors are valid." |