Refresh and Update TCP documentation (#2627) (#2679)

* init client app doc

* init TCP section

* add redirect for TCP client doc

* Redis and Mysql

* finish TCP exampels

* init Draft template

* cleanup whitespace

* escape markdown image in template

* add redirect and update links

* copy edit

* Update readme.md

* fmt

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* optimize png

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* header cleanup and child listing

* Update docs/docs/tcp/ssh.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: cmo-pomerium <91488121+cmo-pomerium@users.noreply.github.com>
Co-authored-by: Bobby DeSimone <bobbydesimone@gmail.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: Alex Fornuto <afornuto@pomerium.com>
Co-authored-by: cmo-pomerium <91488121+cmo-pomerium@users.noreply.github.com>
Co-authored-by: Bobby DeSimone <bobbydesimone@gmail.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
This commit is contained in:
backport-actions-token[bot] 2021-10-14 07:58:37 -07:00 committed by GitHub
parent 585e089239
commit 20e21964d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
26 changed files with 423 additions and 58 deletions

View file

@ -5,11 +5,8 @@ module.exports = {
"Pomerium is a beyond-corp inspired, zero trust, open source identity-aware access proxy.",
plugins: [
"vuepress-plugin-element-tabs",
'vuepress-plugin-mermaidjs',
[
'vuepress-plugin-code-copy',
true
],
"vuepress-plugin-mermaidjs",
["vuepress-plugin-code-copy", true],
[
"check-md",
{
@ -32,14 +29,15 @@ module.exports = {
],
markdown: {
externalLinkSymbol: false,
extendMarkdown:(md) => {
md.use(require('markdown-it-include'), {
root: './docs/partials/'
})
extendMarkdown: (md) => {
md.use(require("markdown-it-include"), {
root: "./docs/partials/",
});
},
},
themeConfig: {
home: false,
activeHeaderLinks: false,
logo: "/img/logo_white.svg",
repo: "pomerium/pomerium",
editLinks: true,
@ -117,6 +115,7 @@ module.exports = {
path: "/docs/identity-providers/",
type: "group",
sidebarDepth: 0,
initialOpenGroupIndex: 0,
children: [
"identity-providers/",
"identity-providers/auth0",
@ -130,13 +129,29 @@ module.exports = {
"identity-providers/ping",
],
},
"client",
{
title: "TCP Connections",
collapsable: false,
path: "/docs/tcp/",
type: "group",
sidebarDepth: 1,
children: [
"tcp/",
"tcp/client",
{
title: "Examples",
collapsable: true,
type: "group",
sidebarDepth: 0,
children: ["tcp/mysql", "tcp/rdp", "tcp/redis", "tcp/ssh"],
},
],
},
{
title: "Topics",
collapsable: true,
collapsable: false,
path: "/docs/topics/",
type: "group",
collapsable: false,
sidebarDepth: 1,
children: [
"topics/certificates",
@ -146,7 +161,6 @@ module.exports = {
"topics/kubernetes-integration",
"topics/production-deployment",
"topics/programmatic-access",
"topics/tcp-support",
"topics/single-sign-out",
"topics/load-balancing",
],
@ -238,7 +252,7 @@ module.exports = {
},
"api",
"upgrading",
"changelog"
"changelog",
],
},
],
@ -246,7 +260,8 @@ module.exports = {
},
head: [
//Hack: Make clicking on the logo go to home url
["script",
[
"script",
{},
`
const logoUrlChanger = setInterval(function() {
@ -268,7 +283,7 @@ module.exports = {
}
}, 1000)
`
]
`,
],
],
};

View file

@ -65,3 +65,6 @@
/docs/quick-start/helm.html /docs/install/helm.html
/docs/quick-start/from-source.html /docs/install/from-source.html
/docs/quick-start/synology.html /docs/guides/synology.html
/docs/client.html /docs/tcp/client.html
/docs/topics/tcp-support.html /docs/tcp/

View file

@ -0,0 +1,14 @@
<template>
<ParentLayout />
</template>
<script>
import ParentLayout from "@parent-theme/layouts/404.vue";
export default {
name: "Draft",
components: {
ParentLayout,
},
};
</script>