Update mkdocs
This commit is contained in:
parent
2e4adde9ee
commit
4ffe3a2fdd
9 changed files with 110 additions and 66 deletions
73
mkdocs.yml
73
mkdocs.yml
|
|
@ -1,7 +1,7 @@
|
|||
site_name: NGINX Ingress Controller
|
||||
strict: true
|
||||
repo_name: 'kubernetes/ingress-nginx'
|
||||
repo_url: 'https://github.com/kubernetes/ingress-nginx'
|
||||
repo_name: "kubernetes/ingress-nginx"
|
||||
repo_url: "https://github.com/kubernetes/ingress-nginx"
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- codehilite
|
||||
|
|
@ -15,13 +15,70 @@ theme:
|
|||
feature:
|
||||
tabs: true
|
||||
logo:
|
||||
icon: 'public' # globe icon
|
||||
icon: "public" # globe icon
|
||||
palette:
|
||||
primary: 'teal'
|
||||
accent: 'green'
|
||||
primary: "teal"
|
||||
accent: "green"
|
||||
include_sidebar: true
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- awesome-pages:
|
||||
collapse_single_pages: true
|
||||
|
||||
extra_css: [extra.css]
|
||||
google_analytics: ['UA-118407822-1', 'kubernetes.github.io']
|
||||
|
||||
google_analytics: ["UA-118407822-1", "kubernetes.github.io"]
|
||||
|
||||
pages:
|
||||
- Welcome:
|
||||
- Welcome: "index.md"
|
||||
- How it works: 'how-it-works.md'
|
||||
- Troubleshooting: 'troubleshooting.md'
|
||||
- Development: 'development.md'
|
||||
- Deployment:
|
||||
- Installation Guide: "deploy/index.md"
|
||||
- Bare-metal considerations: "deploy/baremetal.md"
|
||||
- Role Based Access Control (RBAC): "deploy/rbac.md"
|
||||
- Upgrade: "deploy/upgrade.md"
|
||||
- User guide:
|
||||
- NGINX Configuration:
|
||||
- Introduction: "user-guide/nginx-configuration/index.md"
|
||||
- Annotations: "user-guide/nginx-configuration/annotations.md"
|
||||
- ConfigMap: "user-guide/nginx-configuration/configmap.md"
|
||||
- Custom NGINX template: "user-guide/nginx-configuration/custom-template.md"
|
||||
- Log format: "user-guide/nginx-configuration/log-format.md"
|
||||
- Command line arguments: "user-guide/cli-arguments.md"
|
||||
- Custom errors: "user-guide/custom-errors.md"
|
||||
- Default backend: "user-guide/default-backend.md"
|
||||
- Exposing TCP and UDP services: "user-guide/exposing-tcp-udp-services.md"
|
||||
- External Articles: "user-guide/external-articles.md"
|
||||
- Miscellaneous: "user-guide/miscellaneous.md"
|
||||
- Prometheus and Grafana installation: "user-guide/monitoring.md"
|
||||
- Multiple Ingress controllers: "user-guide/multiple-ingress.md"
|
||||
- TLS/HTTPS: "user-guide/tls.md"
|
||||
- Third party addons:
|
||||
- ModSecurity Web Application Firewall: "user-guide/third-party-addons/modsecurity.md"
|
||||
- OpenTracing: "user-guide/third-party-addons/opentracing.md"
|
||||
- Examples:
|
||||
- Introduction: "examples/index.md"
|
||||
- Prerequisites: "examples/PREREQUISITES.md"
|
||||
- Sticky Sessions: "examples/affinity/cookie/README.md"
|
||||
- Auth:
|
||||
- Basic Authentication: "examples/auth/basic/README.md"
|
||||
- Client Certificate Authentication: "examples/auth/client-certs/README.md"
|
||||
- External Basic Authentication: "examples/auth/external-auth/README.md"
|
||||
- External OAUTH Authentication: "examples/auth/oauth-external-auth/README.md"
|
||||
- Customization:
|
||||
- Configuration Snippets: "examples/customization/configuration-snippets/README.md"
|
||||
- Custom Configuration: "examples/customization/custom-configuration/README.md"
|
||||
- Custom Errors: "examples/customization/custom-errors/README.md"
|
||||
- Custom Headers: "examples/customization/custom-headers/README.md"
|
||||
- Custom Upstream server checks: "examples/customization/custom-upstream-check/README.md"
|
||||
- External authentication: "examples/customization/external-auth-headers/README.md"
|
||||
- Custom DH parameters for perfect forward secrecy: "examples/customization/ssl-dh-param/README.md"
|
||||
- Sysctl tuning: "examples/customization/sysctl/README.md"
|
||||
- Docker registry: "examples/docker-registry/README.md"
|
||||
- gRPC: "examples/grpc/README.md"
|
||||
- Multi TLS certificate termination: "examples/multi-tls/README.md"
|
||||
- Rewrite: "examples/rewrite/README.md"
|
||||
- Static IPs: "examples/static-ip/README.md"
|
||||
- TLS termination: "examples/tls-termination/README.md"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue