Skip to content

Commit fc4456d

Browse files
rahulaitrahulait
authored
Merge pull request #5 from rahulait/test-branch
Test branch
2 parents 441aec9 + f910f79 commit fc4456d

32 files changed

+1975
-432
lines changed

‎.github/filters.yml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Any file that is not a doc *.md file
22
src:
3-
- "!**/**.md"
3+
- "!docs/**"
4+
- "!**/*.md"
5+
- "!*.md"
6+
- "!.github/CONTRIBUTING.md"
7+
- "!.github/PULL_REQUEST_TEMPLATE.md"
8+
- "!**/README.md"
9+
- "!**/CHANGELOG.md"

‎.github/workflows/ci.yml‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,23 @@ on:
44
push:
55
branches:
66
- main
7-
pull_request: null
7+
paths-ignore:
8+
- 'docs/**'
9+
- '**/*.md'
10+
- '*.md'
11+
- '.github/CONTRIBUTING.md'
12+
- '.github/PULL_REQUEST_TEMPLATE.md'
13+
- '**/README.md'
14+
- '**/CHANGELOG.md'
15+
pull_request:
16+
paths-ignore:
17+
- 'docs/**'
18+
- '**/*.md'
19+
- '*.md'
20+
- '.github/CONTRIBUTING.md'
21+
- '.github/PULL_REQUEST_TEMPLATE.md'
22+
- '**/README.md'
23+
- '**/CHANGELOG.md'
824

925
permissions:
1026
contents: read

‎.github/workflows/docs.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- 'README.md'
9+
- 'docs/**'
10+
- '.github/workflows/docs.yml'
11+
pull_request:
12+
paths:
13+
- 'docs/**'
14+
- '.github/workflows/docs.yml'
15+
16+
permissions:
17+
contents: read
18+
pages: write # to deploy to Pages
19+
id-token: write # to verify the deployment originates from an appropriate source
20+
21+
jobs:
22+
generate-docs:
23+
runs-on: ubuntu-latest
24+
container: docker.io/node:20-bullseye-slim
25+
timeout-minutes: 2
26+
steps:
27+
- uses: actions/checkout@v4
28+
29+
- name: Setup mdBook
30+
run: |
31+
apt-get update
32+
apt-get install curl -y
33+
mkdir mdbook
34+
curl -sSL https://github.com/rust-lang/mdbook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
35+
curl -sSL https://github.com/tommilligan/mdbook-admonish/releases/download/v1.15.0/mdbook-admonish-v1.15.0-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
36+
echo `pwd`/mdbook >> $GITHUB_PATH
37+
38+
- name: Build with mdBook
39+
run: |
40+
cd docs
41+
mdbook build
42+
43+
- name: Setup Pages
44+
uses: actions/configure-pages@v5
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: 'docs/book'
50+
51+
deploy-production:
52+
needs: generate-docs
53+
if: github.event_name == 'push'
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
runs-on: ubuntu-latest
58+
timeout-minutes: 2
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,5 @@ coverage.txt
3939
junit.xml
4040

4141
.DS_Store
42+
43+
docs/book

‎Makefile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ LINODE_REGION ?= us-lax
2525
LINODE_OS ?= linode/ubuntu22.04
2626
KUBECONFIG_PATH ?= $(CURDIR)/test-cluster-kubeconfig.yaml
2727
MGMT_KUBECONFIG_PATH ?= $(CURDIR)/mgmt-cluster-kubeconfig.yaml
28+
MDBOOK_DEV_HOST ?= 0.0.0.0
29+
MDBOOK_DEV_PORT ?= 3000
2830

2931
# if the $DEVBOX_PACKAGES_DIR env variable exists that means we are within a devbox shell and can safely
3032
# use devbox's bin for our tools
@@ -131,6 +133,10 @@ run-debug: build
131133
--kubeconfig=${KUBECONFIG} \
132134
--linodego-debug
133135

136+
.PHONY: docs
137+
docs:
138+
@cd docs && mdbook serve -n $(MDBOOK_DEV_HOST) -p $(MDBOOK_DEV_PORT)
139+
134140
#####################################################################
135141
# E2E Test Setup
136142
#####################################################################

‎README.md‎

Lines changed: 42 additions & 429 deletions
Large diffs are not rendered by default.

‎devbox.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
"kustomize@latest",
1313
"kyverno-chainsaw@latest",
1414
"mockgen@latest",
15-
"yq-go@latest"
15+
"yq-go@latest",
16+
"mdbook@latest",
17+
"mdbook-admonish@latest"
1618
],
1719
"shell": {
1820
"init_hook": [

‎devbox.lock‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,102 @@
633633
}
634634
}
635635
},
636+
"mdbook-admonish@latest": {
637+
"last_modified": "2024-12-23T21:10:33Z",
638+
"resolved": "github:NixOS/nixpkgs/de1864217bfa9b5845f465e771e0ecb48b30e02d#mdbook-admonish",
639+
"source": "devbox-search",
640+
"version": "1.18.0",
641+
"systems": {
642+
"aarch64-darwin": {
643+
"outputs": [
644+
{
645+
"name": "out",
646+
"path": "/nix/store/hrmry6gcyxq576yyvvv2vsl05sycmi1y-mdbook-admonish-1.18.0",
647+
"default": true
648+
}
649+
],
650+
"store_path": "/nix/store/hrmry6gcyxq576yyvvv2vsl05sycmi1y-mdbook-admonish-1.18.0"
651+
},
652+
"aarch64-linux": {
653+
"outputs": [
654+
{
655+
"name": "out",
656+
"path": "/nix/store/fg3pqy6459lx562bq6gdf8hdhf2wh0h5-mdbook-admonish-1.18.0",
657+
"default": true
658+
}
659+
],
660+
"store_path": "/nix/store/fg3pqy6459lx562bq6gdf8hdhf2wh0h5-mdbook-admonish-1.18.0"
661+
},
662+
"x86_64-darwin": {
663+
"outputs": [
664+
{
665+
"name": "out",
666+
"path": "/nix/store/0vddbww043c8w1d4sfk2wpb5ljyq45x7-mdbook-admonish-1.18.0",
667+
"default": true
668+
}
669+
],
670+
"store_path": "/nix/store/0vddbww043c8w1d4sfk2wpb5ljyq45x7-mdbook-admonish-1.18.0"
671+
},
672+
"x86_64-linux": {
673+
"outputs": [
674+
{
675+
"name": "out",
676+
"path": "/nix/store/hs7z4g4v6acd9km5kaw7gibxdpcdijbj-mdbook-admonish-1.18.0",
677+
"default": true
678+
}
679+
],
680+
"store_path": "/nix/store/hs7z4g4v6acd9km5kaw7gibxdpcdijbj-mdbook-admonish-1.18.0"
681+
}
682+
}
683+
},
684+
"mdbook@latest": {
685+
"last_modified": "2024-12-23T21:10:33Z",
686+
"resolved": "github:NixOS/nixpkgs/de1864217bfa9b5845f465e771e0ecb48b30e02d#mdbook",
687+
"source": "devbox-search",
688+
"version": "0.4.43",
689+
"systems": {
690+
"aarch64-darwin": {
691+
"outputs": [
692+
{
693+
"name": "out",
694+
"path": "/nix/store/5yibli76rfaq70cv0lyasndswbf3hjw8-mdbook-0.4.43",
695+
"default": true
696+
}
697+
],
698+
"store_path": "/nix/store/5yibli76rfaq70cv0lyasndswbf3hjw8-mdbook-0.4.43"
699+
},
700+
"aarch64-linux": {
701+
"outputs": [
702+
{
703+
"name": "out",
704+
"path": "/nix/store/130z9032izdwxdishjkvjrdfacyd1fkq-mdbook-0.4.43",
705+
"default": true
706+
}
707+
],
708+
"store_path": "/nix/store/130z9032izdwxdishjkvjrdfacyd1fkq-mdbook-0.4.43"
709+
},
710+
"x86_64-darwin": {
711+
"outputs": [
712+
{
713+
"name": "out",
714+
"path": "/nix/store/4lcz6mj30f40k08q2s2phdfnydmkk8w2-mdbook-0.4.43",
715+
"default": true
716+
}
717+
],
718+
"store_path": "/nix/store/4lcz6mj30f40k08q2s2phdfnydmkk8w2-mdbook-0.4.43"
719+
},
720+
"x86_64-linux": {
721+
"outputs": [
722+
{
723+
"name": "out",
724+
"path": "/nix/store/izq6ww5isq00l6l02i4yhad2ykn45djm-mdbook-0.4.43",
725+
"default": true
726+
}
727+
],
728+
"store_path": "/nix/store/izq6ww5isq00l6l02i4yhad2ykn45djm-mdbook-0.4.43"
729+
}
730+
}
731+
},
636732
"mockgen@latest": {
637733
"last_modified": "2024-11-03T14:18:04Z",
638734
"resolved": "github:NixOS/nixpkgs/4ae2e647537bcdbb82265469442713d066675275#mockgen",

‎docs/book.toml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[book]
2+
authors = ["Linode"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "Linode Cloud Controller Manager"
7+
description = "Documentation for the Kubernetes Cloud Controller Manager for Linode"
8+
9+
[output.html]
10+
git-repository-url = "https://github.com/linode/linode-cloud-controller-manager"
11+
site-url = "/linode-cloud-controller-manager/"
12+
edit-url-template = "https://github.com/linode/linode-cloud-controller-manager/edit/master/docs/{path}"
13+
14+
[preprocessor]
15+
16+
[preprocessor.admonish]
17+
command = "mdbook-admonish"
18+
assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
19+
20+
[output.html.playground]
21+
editable = true
22+
line-numbers = true
23+
24+
[output.html.search]
25+
limit-results = 20
26+
use-boolean-and = true
27+
boost-title = 2
28+
boost-hierarchy = 2
29+
boost-paragraph = 1
30+
expand = true
31+
heading-split-level = 2

‎docs/src/SUMMARY.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Summary
2+
3+
[Introduction](./introduction.md)
4+
5+
# User Guide
6+
7+
- [Getting Started](./getting-started/README.md)
8+
- [Overview](./getting-started/overview.md)
9+
- [Requirements](./getting-started/requirements.md)
10+
- [Installation](./getting-started/installation.md)
11+
- [Helm Installation](./getting-started/helm-installation.md)
12+
- [Manual Installation](./getting-started/manual-installation.md)
13+
- [Verification](./getting-started/verification.md)
14+
- [Troubleshooting](./getting-started/troubleshooting.md)
15+
16+
- [Configuration](./configuration/README.md)
17+
- [LoadBalancer Services](./configuration/loadbalancer.md)
18+
- [Service Annotations](./configuration/annotations.md)
19+
- [Node Configuration](./configuration/nodes.md)
20+
- [Environment Variables](./configuration/environment.md)
21+
- [Firewall Setup](./configuration/firewall.md)
22+
- [Route Configuration](./configuration/routes.md)
23+
- [Session Affinity](./configuration/session-affinity.md)
24+
25+
- [Examples](./examples/README.md)
26+
- [Basic Services](./examples/basic.md)
27+
- [Advanced Configuration](./examples/advanced.md)
28+
29+
- [Development Guide](./development/README.md)
30+
31+
---
32+
33+
[Getting Help](./help.md)

0 commit comments

Comments
 (0)