docs: add contributing.md

This commit is contained in:
Bobby DeSimone 2019-07-12 18:02:38 -07:00
parent 51e15daffd
commit 92a839036d
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E
3 changed files with 210 additions and 130 deletions

View file

@ -1,59 +1,67 @@
// .vuepress/config.js
module.exports = {
title: "Pomerium",
description: "An open source identity-aware access proxy.",
plugins: {
'sitemap': {
hostname: 'https://www.pomerium.io'
},
'@vuepress/google-analytics': {
ga: 'UA-129872447-2'
}
},
extend: '@vuepress/theme-default',
themeConfig: {
repo: "pomerium/pomerium",
editLinks: true,
docsDir: "docs",
editLinkText: "Edit this page on GitHub",
lastUpdated: "Last Updated",
nav: [
{ text: "Documentation", link: "/docs/" },
{ text: "Quick Start", link: "/guide/" },
{ text: "Config Reference", link: "/reference/" },
{
text: 'Versions',
items: [
{ text: 'v0.0.5', link: 'https://v0-0-5.docs.pomerium.io/' },
{ text: 'v0.0.4', link: 'https://v0-0-4.docs.pomerium.io/' },
]
},
],
sidebar: {
"/guide/": guideSidebar("Quick Start"),
"/docs/": docsSidebar("Documentation")
}
}
title: "Pomerium",
description: "An open source identity-aware access proxy.",
plugins: {
sitemap: {
hostname: "https://www.pomerium.io"
},
"@vuepress/google-analytics": {
ga: "UA-129872447-2"
}
},
extend: "@vuepress/theme-default",
themeConfig: {
repo: "pomerium/pomerium",
editLinks: true,
docsDir: "docs",
editLinkText: "Edit this page on GitHub",
lastUpdated: "Last Updated",
nav: [
{ text: "Documentation", link: "/docs/" },
{ text: "Quick Start", link: "/guide/" },
{ text: "Config Reference", link: "/reference/" },
{
text: "Versions",
items: [
{ text: "v0.0.5", link: "https://v0-0-5.docs.pomerium.io/" },
{ text: "v0.0.4", link: "https://v0-0-4.docs.pomerium.io/" }
]
}
],
sidebar: {
"/guide/": guideSidebar("Quick Start"),
"/docs/": docsSidebar("Documentation")
}
}
};
function guideSidebar(title) {
return [
{
title,
collapsable: false,
children: ["", "binary", "from-source", "helm", "kubernetes", "synology"]
}
];
return [
{
title,
collapsable: false,
children: ["", "binary", "from-source", "helm", "kubernetes", "synology"]
}
];
}
function docsSidebar(title) {
return [
{
title,
collapsable: false,
children: ["", "identity-providers", "signed-headers", "certificates", "examples", "impersonation", "programmatic-access", "upgrading"]
}
];
return [
{
title,
collapsable: false,
children: [
"",
"identity-providers",
"signed-headers",
"certificates",
"examples",
"impersonation",
"programmatic-access",
"upgrading",
"contributing"
]
}
];
}