-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use GitHub Markdown blockquote tags instead of Alert
Use tags like `[!NOTE]`, `[!TIP]`, `[!WARNING]`, and `[!IMPORTANT]` instead of importing and using an `<Alert>` tag. Signed-off-by: Thomas Hallgren <thomas@tada.se>
- Loading branch information
Showing
13 changed files
with
176 additions
and
117 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Telepresence Documentation | ||
|
||
This folder contains the Telepresence documentation in a format suitable for a versioned folder in the | ||
telepresenceio/telepresence.io repository. The folder will show up in that repository when a new minor revision | ||
tag is created here. | ||
|
||
Assuming that a 2.20.0 release is pending, and that a release/v2.20.0 branch has been created, then: | ||
```console | ||
$ export TELEPRESENCE_VERSION=v2.20.0 | ||
$ make prepare-release | ||
$ git push origin {,rpc/}v2.20.0 release/v2.20.0 | ||
``` | ||
|
||
will result in a `docs/v2.20` folder with this folder's contents in the telepresenceio/telepresence.io repository. | ||
|
||
Subsequent bugfix tags for the same minor tag, i.e.: | ||
```console | ||
$ export TELEPRESENCE_VERSION=v2.20.1 | ||
$ make prepare-release | ||
$ git push origin {,rpc/}v2.20.1 release/v2.20.1 | ||
``` | ||
will not result in a new folder when it is pushed, but it will update the content of the `docs/v2.20` folder to | ||
reflect this folder's content for that tag. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,39 @@ | ||
# Telepresence Documentation | ||
# <img src=images/logo.png height=64px/> Telepresence Documentation | ||
raw markdown version, more bells and whistles at [telepresence.io](https://telepresence.io) | ||
|
||
This folder contains the Telepresence documentation in a format suitable for a versioned folder in the | ||
telepresenceio/telepresence.io repository. The folder will show up in that repository when a new minor revision | ||
tag is created here. | ||
|
||
Assuming that a 2.20.0 release is pending, and that a release/v2.20.0 branch has been created, then: | ||
```console | ||
$ export TELEPRESENCE_VERSION=v2.20.0 | ||
$ make prepare-release | ||
$ git push origin {,rpc/}v2.20.0 release/v2.20.0 | ||
``` | ||
|
||
will result in a `docs/v2.20` folder with this folder's contents in the telepresenceio/telepresence.io repository. | ||
|
||
Subsequent bugfix tags for the same minor tag, i.e.: | ||
```console | ||
$ export TELEPRESENCE_VERSION=v2.20.1 | ||
$ make prepare-release | ||
$ git push origin {,rpc/}v2.20.1 release/v2.20.1 | ||
``` | ||
will not result in a new folder when it is pushed, but it will update the content of the `docs/v2.20` folder to | ||
reflect this folder's content for that tag. | ||
- [Quick start](quick-start.md) | ||
- Install Telepresence | ||
- [Install Client](install/client.md) | ||
- [Upgrade Client](install/upgrade.md) | ||
- [Install Traffic Manager](install/manager.md) | ||
- [Cloud Provider Prerequisites](install/cloud.md) | ||
- Core concepts | ||
- [The developer experience and the inner dev loop](concepts/devloop.md) | ||
- [Making the remote local: Faster feedback, collaboration and debugging](concepts/faster.md) | ||
- [Intercepts](concepts/intercepts.md) | ||
- How do I... | ||
- [Intercept a service in your own environment](howtos/intercepts.md) | ||
- [Proxy outbound traffic to my cluster](howtos/outbound.md) | ||
- [Work with large clusters](howtos/large-clusters.md) | ||
- [Host a cluster in a local VM](howtos/cluster-in-vm.md) | ||
- Technical reference | ||
- [Architecture](reference/architecture.md) | ||
- [Client reference](reference/client.md) | ||
- [Laptop-side configuration](reference/config.md) | ||
- [Cluster-side configuration](reference/cluster-config.md) | ||
- [Using Docker for intercepts](reference/docker-run.md) | ||
- [Running Telepresence in a Docker container](reference/inside-container.md) | ||
- [Environment variables](reference/environment.md) | ||
- [Intercepts](reference/intercepts.md) | ||
- [Configure intercept using CLI](reference/intercepts/cli.md) | ||
- [Volume mounts](reference/volume.md) | ||
- [DNS resolution](reference/dns.md) | ||
- [RBAC](reference/rbac.md) | ||
- [Telepresence and VPNs](reference/vpn.md) | ||
- [Networking through Virtual Network Interface](reference/tun-device.md) | ||
- [Connection Routing](reference/routing.md) | ||
- [FAQs](faqs.md) | ||
- [Troubleshooting](troubleshooting.md) | ||
- [Community](community.md) | ||
- [Release Notes](release-notes.md) | ||
- [Licenses](licenses.md) |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.