Skip to content

Commit 71dbf64

Browse files
weltekialexellis
authored andcommitted
Update docs layout to use tab navigation
Split out the docs in clear sections: inlets, inlets uplink and reference. (A section for inlets could be added.) This should help people maintain a good overview while navigating the docs and make the distinction between the different inlets products clearer. Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>
1 parent bf77ce5 commit 71dbf64

File tree

5 files changed

+47
-40
lines changed

5 files changed

+47
-40
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Inlets documentation
22
=====================
33

4+
## Development
5+
6+
### Run locally
47
Pre-reqs
58

69
You'll need Python and pip installed, then run:
@@ -15,6 +18,15 @@ Local testing:
1518
mkdocs serve
1619
```
1720

21+
22+
### Run with docker
23+
24+
Run in docker container
25+
26+
```sh
27+
docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material:latest
28+
```
29+
1830
Access the site at http://127.0.0.1:8000
1931

2032
## Contributing

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Inlets documentation
1+
# Inlets
22

33
[Inlets](https://inlets.dev) brings secure tunnels to Cloud Native workloads.
44

File renamed without changes.

docs/uplink/overview.md renamed to docs/uplink/index.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Inlets Uplink overview
1+
# Inlets Uplink
22

33
!!! info "What's the difference between Inlets Pro and Inlets Uplink?"
44

@@ -28,13 +28,4 @@ With Uplink, you deploy tunnel servers for a customers to your Kubernetes cluste
2828

2929
You can read more about why we created inlets uplink [in the product announcement](https://inlets.dev/blog/2022/11/16/service-provider-uplinks.html).
3030

31-
## Table of Contents
32-
33-
* [Become a provider](/uplink/become-a-provider)
34-
* [Create a tunnel](/uplink/create-tunnels)
35-
* [Connect to a tunnel](/uplink/connect-to-tunnels)
36-
* [Manage tunnels](/uplink/manage-tunnels)
37-
* [Expose tunnels publicly (optional)](/uplink/ingress-for-tunnels)
38-
* [Monitor tunnels](/uplink/monitoring-tunnels)
39-
40-
You can reach out to us if you have questions: [Contact the inlets team](https://inlets.dev/contact)
31+
Reach out to us if you have questions: [Contact the inlets team](https://inlets.dev/contact)

mkdocs.yml

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ theme:
3030
code: Roboto Mono
3131
features:
3232
- navigation.tracking
33+
- navigation.tabs
3334
- navigation.sections
35+
# - navigation.indexes
36+
- navigation.top
3437
# - toc.integrate
3538
# - navigation.instant
3639

@@ -85,42 +88,43 @@ markdown_extensions:
8588
alternate_style: true
8689

8790
nav:
88-
- Overview:
89-
- Introduction: index.md
90-
- FAQ: /reference/faq/
91-
- Tutorials:
92-
- Automated HTTPs tunnel server: /tutorial/automated-http-server/
93-
- Manual HTTPs tunnel server: /tutorial/manual-http-server/
94-
- Manual TCP tunnel server: /tutorial/manual-tcp-server/
95-
- Dual TCP and HTTPs server: /tutorial/dual-tunnels/
91+
- Inlets:
92+
- Overview: index.md
93+
- FAQ: reference/faq.md
94+
- Tutorials:
95+
- Automated HTTPs tunnel server: tutorial/automated-http-server.md
96+
- Manual HTTPs tunnel server: tutorial/manual-http-server.md
97+
- Manual TCP tunnel server: tutorial/manual-tcp-server.md
98+
- Dual TCP and HTTPs server: tutorial/dual-tunnels.md
99+
- GitHub Actions (ext): https://inlets.dev/blog/2021/12/06/private-deploy-from-github-actions.html
96100
- IP Allow list (ext): https://inlets.dev/blog/2021/10/15/allow-lists.html
97101
- Docker Compose (ext): https://inlets.dev/blog/2021/09/09/compose-and-inlets.html
98-
- Community tutorials: /tutorial/community/
99-
- Tutorials for TCP tunnels:
100-
- Run Caddy on a private network: /tutorial/caddy-http-tunnel/
102+
- Community tutorials: tutorial/community.md
103+
- Tutorials for TCP tunnels:
104+
- Run Caddy on a private network: tutorial/caddy-http-tunnel.md
101105
- Local port forwarding: https://inlets.dev/blog/2021/04/13/local-port-forwarding-kubernetes.html
102-
- Tunnel SSH: /tutorial/ssh-tcp-tunnel/
103-
- Tunnel Postgresql: /tutorial/postgresql-tcp-tunnel/
104-
- Kubernetes:
105-
- Kubernetes Ingress: /tutorial/kubernetes-ingress/
106-
- Kubernetes API Server: /tutorial/kubernetes-api-server/
107-
- Istio Gateway: /tutorial/istio-gateway/
106+
- Tunnel SSH: tutorial/ssh-tcp-tunnel.md
107+
- Tunnel Postgresql: tutorial/postgresql-tcp-tunnel.md
108+
- Kubernetes:
109+
- Kubernetes Ingress: tutorial/kubernetes-ingress.md
110+
- Kubernetes API Server: tutorial/kubernetes-api-server.md
111+
- Istio Gateway: tutorial/istio-gateway.md
108112
- Helm charts (ext): https://github.com/inlets/inlets-pro/tree/master/chart
109113
- Local port forwarding (ext): https://inlets.dev/blog/2022/06/24/fixing-kubectl-port-forward.html
110114
- Manage private clusters with ArgoCD (ext): https://inlets.dev/blog/2022/08/10/managing-tunnel-servers-with-argocd.html
111115
- Inlets Uplink:
112-
- Overview: /uplink/overview/
113-
- Become a provider: /uplink/become-a-provider/
114-
- Create a tunnel: /uplink/create-tunnels/
115-
- Manage tunnels: /uplink/manage-tunnels/
116-
- Connect to tunnels: /uplink/connect-to-tunnels/
117-
- Monitor tunnels: /uplink/monitoring-tunnels/
118-
- Ingress for tunnels: /uplink/ingress-for-tunnels/
116+
- Overview: uplink/index.md
117+
- Become a provider: uplink/become-a-provider.md
118+
- Create a tunnel: uplink/create-tunnels.md
119+
- Manage tunnels: uplink/manage-tunnels.md
120+
- Connect to tunnels: uplink/connect-to-tunnels.md
121+
- Monitor tunnels: uplink/monitoring-tunnels.md
122+
- Ingress for tunnels: uplink/ingress-for-tunnels.md
119123
- Reference:
120-
- Overview: reference.md
121-
- Inlets Operator: /reference/inlets-operator/
122-
- inletsctl: /reference/inletsctl/
123-
- Monitoring and metrics: /tutorial/monitoring-and-metrics/
124+
- Overview: reference/index.md
125+
- Inlets Operator: reference/inlets-operator.md
126+
- inletsctl: reference/inletsctl.md
127+
- Monitoring and metrics: tutorial/monitoring-and-metrics.md
124128

125129
extra:
126130
analytics:

0 commit comments

Comments
 (0)