docs: initial layout for static site (#801)
Signed-off-by: Ernest Wong <chuwon@microsoft.com>
This commit is contained in:
Ernest Wong
GitHub
Родитель
38eb91619d
Коммит
2d58ff3583
|
|
@ -0,0 +1,31 @@
|
|||
name: github pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-18.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
|
||||
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v2
|
||||
with:
|
||||
hugo-version: "0.75.1"
|
||||
extended: true
|
||||
|
||||
- name: Build
|
||||
run: |
|
||||
make -C website production-build
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./website/public
|
||||
|
|
@ -326,3 +326,7 @@ __pycache__/
|
|||
|
||||
# cover profile
|
||||
coverage.txt
|
||||
|
||||
# website
|
||||
website/public
|
||||
website/resources
|
||||
|
|
|
|||
|
|
@ -0,0 +1,3 @@
|
|||
[submodule "website/themes/book"]
|
||||
path = website/themes/book
|
||||
url = https://github.com/alex-shpak/hugo-book
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
[build]
|
||||
base = "website/"
|
||||
publish = "/public"
|
||||
|
||||
[context.deploy-preview]
|
||||
command = "make preview-build"
|
||||
|
||||
[context.deploy-preview.environment]
|
||||
HUGO_VERSION = "0.75.1"
|
||||
HUGO_ENABLEGITINFO = "true"
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
serve:
|
||||
hugo server \
|
||||
--buildDrafts \
|
||||
--buildFuture \
|
||||
--disableFastRender
|
||||
|
||||
production-build:
|
||||
hugo --minify
|
||||
|
||||
preview-build:
|
||||
hugo \
|
||||
--baseURL $(DEPLOY_PRIME_URL) \
|
||||
--buildDrafts \
|
||||
--buildFuture \
|
||||
--minify
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
# Basic site config
|
||||
title = "AAD Pod Identity"
|
||||
baseURL = "https://azure.github.io/aad-pod-identity"
|
||||
languageCode = "en-us"
|
||||
enableRobotsTxt = true
|
||||
|
||||
# Syntax highlighting config
|
||||
pygmentsCodeFences = true
|
||||
pygmentsStyle = "fruity"
|
||||
|
||||
theme = "book"
|
||||
|
||||
[params]
|
||||
# (Optional, default light) Sets color theme: light, dark or auto.
|
||||
# Theme 'auto' switches between dark and light modes based on browser/os preferences
|
||||
BookTheme = 'light'
|
||||
|
||||
# (Optional, default true) Controls table of contents visibility on right side of pages.
|
||||
# Start and end levels can be controlled with markup.tableOfContents setting.
|
||||
# You can also specify this parameter per page in front matter.
|
||||
BookToC = true
|
||||
|
||||
# (Optional, default none) Set the path to a logo for the book. If the logo is
|
||||
# /static/logo.png then the path would be 'logo.png'
|
||||
BookLogo = ''
|
||||
|
||||
# (Optional, default none) Set leaf bundle to render as side menu
|
||||
# When not specified file structure and weights will be used
|
||||
BookMenuBundle = '/menu'
|
||||
|
||||
# (Optional, default docs) Specify section of content to render as menu
|
||||
# You can also set value to "*" to render all sections to menu
|
||||
BookSection = 'docs'
|
||||
|
||||
# Set source repository location.
|
||||
# Used for 'Last Modified' and 'Edit this page' links.
|
||||
BookRepo = 'https://github.com/Azure/aad-pod-identity'
|
||||
|
||||
# Enable 'Edit this page' links for 'doc' page type.
|
||||
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
|
||||
# Path must point to the site directory.
|
||||
BookEditPath = 'edit/master/website/content'
|
||||
|
||||
# (Optional, default January 2, 2006) Configure the date format used on the pages
|
||||
# - In git information
|
||||
# - In blog posts
|
||||
BookDateFormat = 'January 2, 2006'
|
||||
|
||||
# (Optional, default true) Enables search function with flexsearch,
|
||||
# Index is built on fly, therefore it might slowdown your website.
|
||||
# Configuration for indexing can be adjusted in i18n folder per language.
|
||||
BookSearch = true
|
||||
|
||||
# (Optional, default true) Enables comments template on pages
|
||||
# By default partials/docs/comments.html includes Disqus template
|
||||
# See https://gohugo.io/content-management/comments/#configure-disqus
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments = false
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
# Theme will print warning if page referenced in markdown does not exists.
|
||||
BookPortableLinks = true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
|
||||
BookServiceWorker = true
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Introduction
|
||||
type: docs
|
||||
---
|
||||
|
||||
# AAD Pod Identity
|
||||
|
||||
AAD Pod Identity enables Kubernetes applications to access cloud resources securely with [Azure Active Directory](AAD).
|
||||
|
||||
Using Kubernetes primitives, administrators configure identities and bindings to match pods. Then without any code modifications, your containerized applications can leverage any resource in the cloud that depends on AAD as an identity provider.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Best Practices
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Best Practices
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Code of Conduct
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Code of Conduct
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Concepts
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Concepts
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: AzureAssignedIdentity
|
||||
type: docs
|
||||
---
|
||||
|
||||
# `AzureAssignedIdentity`
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: AzureIdentity
|
||||
type: docs
|
||||
---
|
||||
|
||||
# `AzureIdentity`
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: AzureIdentityBinding
|
||||
type: docs
|
||||
---
|
||||
|
||||
# `AzureIdentityBinding`
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: AzurePodIdentityException
|
||||
type: docs
|
||||
---
|
||||
|
||||
# `AzurePodIdentityException`
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Managed Identity Controller
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Managed Identity Controller (MIC)
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Node-Managed Identity
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Node-Managed Identity (NMI)
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Role Assignments
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Role Assignments
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Demo
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Demo
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Development
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Development
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Features
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Features
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Feature Flags
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Feature Flags
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Managed Mode
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Managed Mode
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Monitoring with Prometheus
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Monitoring with Prometheus
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Namespaced Mode
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Namespaced Mode
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Non-Cluster Credentials for MIC
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Non-Cluster Credentials for MIC
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Validation Using Gatekeeper
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Validation Using Gatekeeper
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Getting Started
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
## Role Assignments
|
||||
|
||||
## Next Steps
|
||||
|
||||
Try out the demo
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Known Issues
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Known Issues
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
+++
|
||||
headless = false
|
||||
+++
|
||||
|
||||
- [Introduction]({{< relref "/" >}})
|
||||
- [Release Notes]({{< relref "/release-notes" >}})
|
||||
- [Getting Started]({{< relref "/getting-started" >}})
|
||||
- [1 Concepts]({{< relref "/concepts" >}})
|
||||
- [1.1 AzureIdentity]({{< relref "/concepts/azureidentity" >}})
|
||||
- [1.2 AzureIdentityBinding]({{< relref "/concepts/azureidentitybinding" >}})
|
||||
- [1.3 AzureAssignedIdentity]({{< relref "/concepts/azureassignedidentity" >}})
|
||||
- [1.4 AzurePodIdentityException]({{< relref "/concepts/azurepodidentityexception" >}})
|
||||
- [1.5 Managed Identity Controller (MIC)]({{< relref "/concepts/mic" >}})
|
||||
- [1.6 Node-Managed Identity (NMI)]({{< relref "/concepts/nmi" >}})
|
||||
- [2 Features]({{< relref "/features" >}})
|
||||
- [2.1 Feature Flags]({{< relref "/features/feature-flags" >}})
|
||||
- [2.2 Managed Mode]({{< relref "/features/managed-mode" >}})
|
||||
- [2.3 Monitoring With Prometheus]({{< relref "/features/monitoring-with-prometheus" >}})
|
||||
- [2.4 Namespaced Mode]({{< relref "/features/namespaced-mode" >}})
|
||||
- [2.5 Non-Cluster Credentials for MIC]({{< relref "/features/non-cluster-credentials-for-mic" >}})
|
||||
- [2.6 Validation Using Gatekeeper]({{< relref "/features/validation-using-gatekeeper" >}})
|
||||
- [3 Best Practices]({{< relref "/best-practices" >}})
|
||||
- [4 Troubleshooting]({{< relref "/troubleshooting" >}})
|
||||
- [5 Known Issues]({{< relref "/known-issues" >}})
|
||||
- [6 Uninstall Note]({{< relref "/uninstall-note" >}})
|
||||
- [7 Development]({{< relref "/development" >}})
|
||||
- [8 Code of Conduct]({{< relref "/code-of-conduct" >}})
|
||||
- [9 Support]({{< relref "/support" >}})
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Release Notes
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Release Notes
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Support
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Support
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Troubleshooting
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Uninstall Note
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Uninstall Note
|
||||
|
|
@ -0,0 +1 @@
|
|||
Subproject commit b76bdd715bee152c7f5a3dd377f85d952d8c4724
|
||||
Загрузка…
Ссылка в новой задаче