Skip to content

Commit 5da3dd7

Browse files
authored
Merge branch 'main' into mcdan/fix/1418
2 parents 3897baa + 546da5e commit 5da3dd7

File tree

428 files changed

+23252
-792
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

428 files changed

+23252
-792
lines changed

.dockerignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Ignore node_modules directory
2+
node_modules
3+
4+
# Ignore any log files
5+
*.log
6+
7+
# Ignore Dockerfile and .dockerignore itself
8+
Dockerfile
9+
.dockerignore
10+
11+
# Ignore git repository files
12+
.git
13+
.gitignore
14+
15+
# Ignore temporary files
16+
tmp
17+
*.tmp
18+
19+
# Ignore build output
20+
dist
21+
build
22+
resources
23+
app

.github/workflows/build.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: build
2+
3+
on:
4+
push:
5+
paths:
6+
- sdkexamples/**
7+
branches:
8+
- main
9+
pull_request:
10+
paths:
11+
- sdkexamples/**
12+
branches:
13+
- main
14+
15+
permissions:
16+
contents: read
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
strategy:
22+
fail-fast: true
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
26+
- name: Setup Go sdkexamples/go.mod file
27+
uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # [email protected]
28+
with:
29+
go-version-file: 'sdkexamples/go.mod'
30+
check-latest: true
31+
- name: Build sdkexamples
32+
run: make sdkexamples

.github/workflows/typos.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: typos
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
typos:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
20+
- name: Check for typos
21+
uses: crate-ci/[email protected]

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,14 @@ app/*
1717
resources/
1818
helm.sh/
1919
docs.helm.sh/
20+
sdkexamples/sdkexamples
2021

2122
# JetBrains IDEs (GoLand, IntelliJ, ...) config folder
2223
.idea
2324

25+
# Obsidian IDE config folder
26+
.obsidian
27+
2428
# Link checker artifacts
2529
bin/
2630
tmp/

.typos.toml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
[default]
2+
extend-ignore-re = [
3+
# Hex color codes in SCSS/CSS
4+
"F[0-9A-F]{2,4}",
5+
]
6+
7+
[default.extend-words]
8+
# Company/Publisher names
9+
Packt = "Packt"
10+
SkippBox = "SkippBox"
11+
Skipp = "Skipp"
12+
KOMMA = "KOMMA"
13+
Hashi = "Hashi" # HashiCorp
14+
15+
# Icon/variable names
16+
stange = "stange"
17+
mutliple = "mutliple" # May be intentional in legacy code
18+
multiplebgs = "multiplebgs"
19+
psuedo = "psuedo" # Legacy typo in vendor code
20+
21+
# Technical terms
22+
AKS = "AKS" # Azure Kubernetes Service
23+
ba = "ba"
24+
ede = "ede" # Git commit hash
25+
26+
# German words in translations
27+
Paket = "Paket" # German for "package"
28+
29+
[files]
30+
extend-exclude = [
31+
# Internationalization files
32+
"i18n/",
33+
# Portuguese content - these are not English typos
34+
"content/pt/**",
35+
# Polish content
36+
"content/pl/**",
37+
# Russian content
38+
"content/ru/**",
39+
# Ukrainian content
40+
"content/uk/**",
41+
# Korean content
42+
"content/ko/**",
43+
# Japanese content
44+
"content/ja/**",
45+
# German content
46+
"content/de/**",
47+
# Spanish content
48+
"content/es/**",
49+
# French content
50+
"content/fr/**",
51+
# Greek content
52+
"content/gr/**",
53+
# Chinese content
54+
"content/zh/**",
55+
# Theme files
56+
"themes/",
57+
# Go dependencies
58+
"sdkexamples/go.mod",
59+
"sdkexamples/go.sum",
60+
]

Dockerfile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
ARG HUGO_VERSION=
2+
FROM hugomods/hugo:node-${HUGO_VERSION}
3+
4+
WORKDIR /src
5+
6+
RUN apk update && apk add --no-cache make curl bash
7+
8+
RUN npm install yarn
9+
10+
COPY . .
11+
12+
RUN npx yarn install
13+
14+
EXPOSE 1313
15+
16+
ENTRYPOINT ["make"]

Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,23 @@ run-link-checker:
2222
bin/htmltest
2323

2424
check-links-ci: set-up-link-checker run-link-checker
25+
26+
.PHONY: sdkexamples
27+
sdkexamples:
28+
make -C sdkexamples
29+
30+
serve:
31+
hugo server --buildDrafts --buildFuture --bind 0.0.0.0
32+
33+
HUGO_VERSION ?= $(shell grep HUGO_VERSION ./netlify.toml | head -1 | cut -d '"' -f 2)
34+
35+
IMAGE_NAME ?= helm-docs
36+
37+
image:
38+
docker build --build-arg HUGO_VERSION=$(HUGO_VERSION) -t $(IMAGE_NAME) .
39+
40+
# Extract the target after 'image-run' or default to 'serve'
41+
DOCKER_TARGET = $(if $(filter-out image-run,$(MAKECMDGOALS)),$(filter-out image-run,$(MAKECMDGOALS)),serve)
42+
43+
image-run:
44+
docker run --rm --init -it -p 1313:1313 -v $(PWD):/src $(IMAGE_NAME) $(DOCKER_TARGET)

OWNERS

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
maintainers:
2+
- gjenkins8
3+
- karenhchu
4+
- mattfarina
5+
- paigecalvert
6+
- scottrigby
7+
- technosophos
8+
- TerryHowe
29
- yxxhero
10+
emeritus:
311
- angellk
412
- bacongobbler
513
- bridgetkromhout
614
- flynnduism
715
- hickeyma
816
- jdolitsky
9-
- karenhchu
10-
- mattfarina
11-
- technosophos
12-
emeritus:
1317
- thomastaylor312

README-ko.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Helm.sh는 사용자 지정 테마를 사용하여 구축된 간단한 [휴고(Hugo)](https://gohugo.io/) 정적 사이트입니다. 웹 사이트를 로컬에서 실행하려면 먼저 휴고와 이와 관련된 모듈(dependencies)을 [설치](https://gohugo.io/getting-started)해야 합니다.
1010

1111
```
12-
brew install hugo
12+
brew install hugo yarn node
1313
yarn install
1414
```
1515

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ This is where you'll find all of the assets that make up [helm.sh](https://helm.
66

77
## Development
88

9-
Helm.sh is a simple [Hugo](https://gohugo.io/) static site, built with a custom theme. To run the website locally, you'll need to first [install](https://gohugo.io/getting-started) Hugo and any dependencies.
9+
Helm.sh is a simple [Hugo](https://gohugo.io/) static site, built with a custom theme. To run the website locally, you'll need to first [install](https://gohugo.io/getting-started) Hugo extended edition and any dependencies.
1010

1111
```
12-
brew install hugo
12+
brew install hugo yarn node
1313
yarn install
1414
```
1515

0 commit comments

Comments
 (0)