adding TOC logic
This commit is contained in:
John Mulhausen
parent
a4f120615d
commit
6d10939575
|
|
@ -15,11 +15,12 @@ defaults:
|
|||
scope:
|
||||
path: ""
|
||||
values:
|
||||
layout: "docs"
|
||||
layout: "docwithnav"
|
||||
-
|
||||
scope:
|
||||
path: "v1.2"
|
||||
values:
|
||||
version: "v1.2"
|
||||
versionfilesafe: "v1_1"
|
||||
|
||||
permalink: pretty
|
||||
|
|
@ -0,0 +1,110 @@
|
|||
toc:
|
||||
- title: Overview
|
||||
path: /v1.1/guides/
|
||||
|
||||
- title: Quickstarts
|
||||
section:
|
||||
- title: Setting Up Your Local Environment
|
||||
path: /v1.1/docs/setup
|
||||
- title: 5-minute Quickstart
|
||||
path: /v1.1/docs/hellonode
|
||||
- title: Kubernetes 101
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/walkthrough/README.html
|
||||
- title: Kubernetes 201
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/walkthrough/k8s201.html
|
||||
|
||||
- title: Running Kubernetes
|
||||
section:
|
||||
- title: Running Kubernetes on Your Local Machine
|
||||
path: http://kubernetes.io/v1.1/gs-localmachine.html
|
||||
- title: Running Kubernetes on Google Container Engine
|
||||
path: https://cloud.google.com/container-engine
|
||||
- title: Running Kubernetes on Turn-key Cloud Solutions
|
||||
path: http://kubernetes.io/v1.1/gs-turnkey.html
|
||||
- title: Running Kubernetes on Custom Solutions
|
||||
path: http://kubernetes.io/v1.1/gs-custom.html
|
||||
|
||||
|
||||
- title: Common Tasks
|
||||
section:
|
||||
- title: Using Clusters
|
||||
path: http://kubernetes.io/v1.1/docs/admin/introduction.html
|
||||
- title: Using Multiple Clusters
|
||||
path: http://kubernetes.io/v1.1/docs/admin/multi-cluster.html
|
||||
- title: Using Large Clusters
|
||||
path: http://kubernetes.io/v1.1/docs/admin/cluster-large.html
|
||||
- title: Building High-Availability Clusters
|
||||
path: http://kubernetes.io/v1.1/docs/admin/high-availability.html
|
||||
- title: Accessing Clusters
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/accessing-the-cluster.html
|
||||
- title: Sharing a Cluster
|
||||
path: http://kubernetes.io/v1.1/docs/admin/namespaces/README.html
|
||||
- title: Changing Cluster Size
|
||||
path: https://github.com/kubernetes/kubernetes/wiki/User-FAQ#how-do-i-change-the-size-of-my-cluster
|
||||
- title: Creating a Custom Cluster from Scratch
|
||||
path: http://kubernetes.io/v1.1/docs/getting-started-guides/scratch.html
|
||||
- title: Authenticating Across Clusters with kubeconfig
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/kubeconfig-file.html
|
||||
|
||||
- title: Using Nodes
|
||||
path: http://kubernetes.io/v1.1/docs/admin/node.html
|
||||
- title: Assigning Pods to Nodes
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/node-selection/README.html
|
||||
|
||||
- title: Using Configuration Files
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/simple-yaml.html
|
||||
- title: Configuring Containers
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/configuring-containers.html
|
||||
- title: Configuring Kubernetes with Salt
|
||||
path: http://kubernetes.io/v1.1/docs/admin/salt.html
|
||||
- title: Using Environment Variables
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/environment-guide/README.html
|
||||
- title: Configuring Garbage Collection
|
||||
path: http://kubernetes.io/v1.1/docs/admin/garbage-collection.html
|
||||
|
||||
- title: Managing Compute Resources
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/compute-resources.html
|
||||
- title: Applying Resource Quotas and Limits
|
||||
path: http://kubernetes.io/v1.1/docs/admin/resourcequota/README.html
|
||||
- title: Setting Pod CPU and Memory Limits
|
||||
path: http://kubernetes.io/v1.1/docs/admin/limitrange/README.html
|
||||
|
||||
- title: Managing Deployments
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/managing-deployments.html
|
||||
- title: Deploying Applications
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/deploying-applications.html
|
||||
- title: Launching, Exposing, and Killing Applications
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/quick-start.html
|
||||
- title: Connecting Applications
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/connecting-applications.html
|
||||
|
||||
- title: Networking in Kubernetes
|
||||
path: http://kubernetes.io/v1.1/docs/admin/networking.html
|
||||
- title: Creating Servers with External IPs
|
||||
path: http://kubernetes.io/v1.1/examples/simple-nginx.html
|
||||
- title: Setting Up and Configuring DNS
|
||||
path: http://kubernetes.io/v1.1/examples/cluster-dns/README.html
|
||||
- title: Using DNS Pods and Services
|
||||
path: http://kubernetes.io/v1.1/docs/admin/dns.html
|
||||
- title: Working with Containers
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/production-pods.html
|
||||
- title: Creating Pods with the Downward API
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/downward-api/README.html
|
||||
- title: Using Secrets
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/secrets/README.html
|
||||
- title: Using Persistent Volumes
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/persistent-volumes/README.html
|
||||
- title: Updating Live Pods
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/update-demo/README.html
|
||||
|
||||
|
||||
- title: Testing and Monitoring
|
||||
section:
|
||||
- title: Simulating Large Test Loads
|
||||
path: http://kubernetes.io/v1.1/examples/k8petstore/README.html
|
||||
- title: Checking Pod Health
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/liveness/README.html
|
||||
- title: Using Explorer to Examine the Runtime Environment
|
||||
path: http://kubernetes.io/v1.1/examples/explorer/README.html
|
||||
- title: Resource Usage Monitoring
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/monitoring.html
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
toc:
|
||||
- title: Kubernetes API
|
||||
path: /v1.1/reference
|
||||
section:
|
||||
- title: Kubernetes API Overview
|
||||
path: http://kubernetes.io/v1.1/docs/api.html
|
||||
- title: Kubernetes API Reference (pretend the child nodes are here)
|
||||
path: http://kubernetes.io/v1.1/api-ref.html
|
||||
|
||||
- title: kubectl
|
||||
section:
|
||||
- title: kubectl Overview
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/kubectl-overview.html
|
||||
- title: kubectl for Docker Users
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/docker-cli-to-kubectl.html
|
||||
- title: kubectl Reference (pretend the child nodes are here)
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/kubectl/kubectl.html
|
||||
|
||||
- title: JSONpath
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/jsonpath.html
|
||||
|
||||
- title: kube-apiserver
|
||||
section:
|
||||
- title: Overview
|
||||
path: http://kubernetes.io/v1.1/docs/admin/kube-apiserver.html
|
||||
- title: Authorization Plugins
|
||||
path: http://kubernetes.io/v1.1/docs/admin/authorization.html
|
||||
- title: Authentication
|
||||
path: http://kubernetes.io/v1.1/docs/admin/authentication.html
|
||||
- title: Accessing the API
|
||||
path: http://kubernetes.io/v1.1/docs/admin/accessing-the-api.html
|
||||
- title: Admission Controllers
|
||||
path: http://kubernetes.io/v1.1/docs/admin/admission-controllers.html
|
||||
- title: Managing Service Accounts
|
||||
path: http://kubernetes.io/v1.1/docs/admin/service-accounts-admin.html
|
||||
|
||||
- title: kub-scheduler
|
||||
path: http://kubernetes.io/v1.1/docs/admin/kube-scheduler.html
|
||||
|
||||
- title: kubelet
|
||||
path: http://kubernetes.io/v1.1/docs/admin/kubelet.html
|
||||
|
||||
- title: kube-proxy
|
||||
path: http://kubernetes.io/v1.1/docs/admin/kube-proxy.html
|
||||
|
||||
- title: etcd
|
||||
path: http://kubernetes.io/v1.1/docs/admin/etcd.html
|
||||
|
||||
- title: Concept Definitions
|
||||
section:
|
||||
- title: Container Environment
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/container-environment.html
|
||||
- title: Images
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/images.html
|
||||
- title: Downward API
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/downward-api.html
|
||||
- title: Pods
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/pods.html
|
||||
- title: Labels and Selectors
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/labels.html
|
||||
- title: Replication Controller
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/replication-controller.html
|
||||
- title: Services
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/services.html
|
||||
- title: Volumes
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/volumes.html
|
||||
- title: Persistent Volumes
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/persistent-volumes.html
|
||||
- title: Secrets
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/secrets.html
|
||||
- title: Names
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/identifiers.html
|
||||
- title: Namespaces
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/namespaces.html
|
||||
- title: Service Accounts
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/service-accounts.html
|
||||
- title: Annotations
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/annotations.html
|
||||
- title: Daemon Sets
|
||||
path: http://kubernetes.io/v1.1/docs/admin/daemons.html
|
||||
- title: Deployments
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/deployments.html
|
||||
- title: Ingress Resources
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/ingress.html
|
||||
- title: Horizontal Pod Autoscaling
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/horizontal-pod-autoscaler.html
|
||||
- title: Jobs
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/jobs.html
|
||||
- title: Resource Quotas
|
||||
path: http://kubernetes.io/v1.1/docs/admin/resource-quota.html
|
||||
|
||||
- title: Kubernetes Design Docs
|
||||
section:
|
||||
- title: Kubernetes Architecture
|
||||
path: http://kubernetes.io/v1.1/docs/design/architecture.html
|
||||
- title: Kubernetes Design Overview
|
||||
path: http://kubernetes.io/v1.1/docs/design/README.html
|
||||
- title: Security in Kubernetes
|
||||
path: http://kubernetes.io/v1.1/docs/design/security.html
|
||||
- title: Kubernetes Identity and Access Management
|
||||
path: http://kubernetes.io/v1.1/docs/design/access.html
|
||||
- title: Security Contexts
|
||||
path: http://kubernetes.io/v1.1/docs/design/security_context.html
|
||||
- title: Kubernetes OpenVSwitch GRE/VxLAN networking
|
||||
path: http://kubernetes.io/v1.1/docs/admin/ovs-networking.html
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
toc:
|
||||
- title: Clustered Application Samples
|
||||
path: /v1.1/samples
|
||||
section:
|
||||
- title: Apache Cassandra Database
|
||||
path: http://kubernetes.io/v1.1/examples/cassandra/README.html
|
||||
- title: Apache Spark
|
||||
path: http://kubernetes.io/v1.1/examples/spark/README.html
|
||||
- title: Apache Storm
|
||||
path: http://kubernetes.io/v1.1/examples/storm/README.html
|
||||
- title: Distributed Task Queue
|
||||
path: http://kubernetes.io/v1.1/examples/celery-rabbitmq/README.html
|
||||
- title: Hazelcast
|
||||
path: http://kubernetes.io/v1.1/examples/hazelcast/README.html
|
||||
- title: Meteor Applications
|
||||
path: http://kubernetes.io/v1.1/examples/meteor/README.html
|
||||
- title: Redis
|
||||
path: http://kubernetes.io/v1.1/examples/redis/README.html
|
||||
- title: RethinkDB
|
||||
path: http://kubernetes.io/v1.1/examples/rethinkdb/README.html
|
||||
- title: Elasticsearch/Kibana Logging Demonstration
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/logging-demo/README.html
|
||||
- title: Elasticsearch
|
||||
path: http://kubernetes.io/v1.1/examples/elasticsearch/README.html
|
||||
- title: OpenShift Origin
|
||||
path: http://kubernetes.io/v1.1/examples/openshift-origin/README.html
|
||||
- title: Ceph
|
||||
path: http://kubernetes.io/v1.1/examples/rbd/README.html
|
||||
|
||||
- title: Persistent Volume Samples
|
||||
section:
|
||||
- title: WordPress on a Kubernetes Persistent Volume
|
||||
path: http://kubernetes.io/v1.1/examples/mysql-wordpress-pd/README.html
|
||||
- title: GlusterFS
|
||||
path: http://kubernetes.io/v1.1/examples/glusterfs/README.html
|
||||
- title: iSCSI
|
||||
path: http://kubernetes.io/v1.1/examples/iscsi/README.html
|
||||
- title: NFS
|
||||
path: http://kubernetes.io/v1.1/examples/nfs/README.html
|
||||
|
||||
- title: Multi-tier Application Samples
|
||||
section:
|
||||
- title: Guestbook - Go Server
|
||||
path: http://kubernetes.io/v1.1/examples/guestbook-go/README.html
|
||||
- title: GuestBook - PHP Server
|
||||
path: http://kubernetes.io/v1.1/examples/guestbook/README.html
|
||||
- title: MySQL - Phabricator Server
|
||||
path: http://kubernetes.io/v1.1/examples/phabricator/README.html
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
toc:
|
||||
- title: Troubleshooting
|
||||
path: /v1.1/support
|
||||
section:
|
||||
- title: Web Interface
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/ui.html
|
||||
- title: Logging
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/logging.html
|
||||
- title: Monitoring
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/monitoring.html
|
||||
- title: Container Access (exec)
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/getting-into-containers.html
|
||||
- title: Connect with Proxies
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/connecting-to-applications-proxy.html
|
||||
- title: Connect with Port Forwarding
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/connecting-to-applications-port-forward.html
|
||||
- title: Troubleshooting Applications
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/application-troubleshooting.html
|
||||
- title: Troubleshooting Clusters
|
||||
path: http://kubernetes.io/v1.1/docs/admin/cluster-troubleshooting.html
|
||||
- title: Best Practices for Configuration
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/config-best-practices.html
|
||||
|
||||
- title: Frequently Asked Questions
|
||||
section:
|
||||
- title: User FAQ
|
||||
path: https://github.com/kubernetes/kubernetes/wiki/User-FAQ
|
||||
- title: Debugging FAQ
|
||||
path: https://github.com/kubernetes/kubernetes/wiki/Debugging-FAQ
|
||||
- title: Services FAQ
|
||||
path: https://github.com/kubernetes/kubernetes/wiki/Services-FAQ
|
||||
|
||||
- title: Other Resources
|
||||
section:
|
||||
- title: Known Issues
|
||||
path: http://kubernetes.io/v1.1/docs/user-guide/known-issues.html
|
||||
- title: Kubernetes Issue Tracker on GitHub
|
||||
path: https://github.com/kubernetes/kubernetes/issues
|
||||
- title: Report a Security Vulnerability
|
||||
path: http://kubernetes.io/v1.1/docs/reporting-security-issues.html
|
||||
- title: Release Notes
|
||||
path: https://github.com/kubernetes/kubernetes/releases
|
||||
- title: Release Roadmap
|
||||
path: http://kubernetes.io/v1.1/docs/roadmap.html
|
||||
Binary file not shown.
|
|
@ -0,0 +1,45 @@
|
|||
|
||||
<ul {% if subsection %}style="display: none; opacity: 0; margin-left: 15px;"{% endif %}>
|
||||
{% for item in tree %}
|
||||
|
||||
{% if item.status %}
|
||||
{% capture statusHTML %} <sup style="color: red">{{item.status}}</sup>{% endcapture %}
|
||||
{% else %}
|
||||
{% assign statusHTML = "" %}
|
||||
{% endif %}
|
||||
|
||||
{% if item.section %}
|
||||
{% capture sectionHTML %}<a class="tlw-control tlw-collapsed">▸</a>{% endcapture %}
|
||||
{% else %}
|
||||
{% assign sectionHTML = "" %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
{% if item.path %}
|
||||
{% if page.url | remove: ".html" | remove "index" == item.path %}
|
||||
{% capture tocItemColor %}style="color:red;"{% endcapture %}
|
||||
{% else %}
|
||||
{% capture tocItemColor %}{% endcapture %}
|
||||
{% endif %}
|
||||
<li {{ tocItemColor }}>{{ sectionHTML }}<a href="{{ item.path }}" title="{{ item.title }}" data-title="{{ item.title }} - {{ item.path }}"><span>{{ item.title }} {{ statusHTML }}</span></a></li>
|
||||
{% else %}
|
||||
{% if item.include %}
|
||||
{% assign tree = site.data[item.include].toc %}
|
||||
{% assign subsection=false %}
|
||||
{% include tree.html %}
|
||||
{% else %}
|
||||
<li>{{ sectionHTML }}<span class="tlw-title tlw-control-title" data-title="{{ item.title }}">{{ item.title }}{{ statusHTML }}</span></li>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if item.break %}
|
||||
<hr>
|
||||
{% endif %}
|
||||
|
||||
{% if item.section %}
|
||||
{% assign tree = item.section %}
|
||||
{% assign subsection=true %}
|
||||
{% include tree.html %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
Binary file not shown.
|
|
@ -17,7 +17,9 @@ layout: headerfooter
|
|||
|
||||
<section id="encyclopedia">
|
||||
<div id="docsToc">
|
||||
HERE IS THE TOC
|
||||
{% comment %} assign tree = site.data[page.toc].toc {% endcomment %}
|
||||
{% assign tree = site.data[page.versionfilesafe][page.section].toc %}
|
||||
{% include tree.html %}
|
||||
</div>
|
||||
<div id="docsContent">
|
||||
{{ content }}
|
||||
|
|
@ -74,7 +74,13 @@
|
|||
|
||||
<section id="encyclopedia">
|
||||
<div id="docsToc">
|
||||
HERE IS THE TOC
|
||||
|
||||
|
||||
|
||||
<ul >
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div id="docsContent">
|
||||
Yep.
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: Doc test
|
||||
abstract: Testing the doducmentation with cascading layouts
|
||||
section: reference
|
||||
---
|
||||
|
||||
# This is a test of the documentation layout use
|
||||
|
|
|
|||
Loading…
Reference in New Issue