Skip to content

Commit 8f41e16

Browse files
committed
docs: migrate documentation from hugo-book to Hextra theme
Migrate the documentation site from the hugo-book theme to the Hextra theme by imfing. This includes a full replacement of the theme vendor directory, new Hugo configuration (hugo.yaml replacing config.toml), updated layouts and partials (sidebar, footer, mobile TOC, theme toggle), custom CSS with a blue-cyan color scheme, callout styles, and responsive design improvements. Update Hugo version from 0.96.0 to 0.146.0. Reorganize documentation content structure with improved navigation, cards, diagrams, and interactive features. Optimize image assets, add favicon and web manifest, and update the doc generation pipeline (.tekton/doc.yaml, hack/gendocs.sh). Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
1 parent 88f59ae commit 8f41e16

File tree

584 files changed

+19954
-15007
lines changed

Some content is hidden

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

584 files changed

+19954
-15007
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,4 @@ tags
5252

5353
#Mac
5454
.DS_Store
55+
/.cursor/plans

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# See https://pre-commit.com for more information
22
# See https://pre-commit.com/hooks.html for more hooks
33
default_install_hook_types: ["pre-push"]
4-
exclude: '(^docs/themes/hugo-book|^vendor|.*golden$|^\.vale)'
4+
exclude: '(^docs/_vendor|^docs/themes/hugo-book|^vendor|.*golden$|^\.vale)'
55
repos:
66
- repo: https://github.com/pre-commit/pre-commit-hooks
77
rev: v6.0.0

.tekton/doc.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ spec:
1616
- name: revision
1717
value: "{{revision}}"
1818
- name: hugo_version
19-
value: "0.96.0"
19+
value: "0.146.0"
2020
pipelineSpec:
2121
params:
2222
- name: repo_url
@@ -76,9 +76,8 @@ spec:
7676
echo "Hugo was not downloaded properly" && exit 1
7777
}
7878
cd $(git rev-parse --show-toplevel)/docs
79-
sed -i '1acanonifyURLs = true' config.toml
8079
url="${UPLOADER_PUBLIC_URL}/docs/{{ pull_request_number }}"
81-
${hugobin} --gc --minify -d {{ pull_request_number }} -b ${url}
80+
${hugobin} --gc --minify --canonifyURLs -d {{ pull_request_number }} -b ${url}
8281
echo "Preview URL: ${url}"
8382
- name: upload-to-static-server
8483
# it has curl and we already pulled it

CLAUDE.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

CLAUDE.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Pipelines-as-Code Project Guide
2+
3+
## Project Overview
4+
5+
- Tekton pipeline integration with Git providers: GitHub, GitLab, Bitbucket, Gitea
6+
- Targets arm64 and amd64 architectures
7+
- Uses `ko` for building container images in development
8+
9+
## Code Quality Workflow
10+
11+
### After Editing Code
12+
13+
**Go files**: `make fumpt` to format
14+
**Python files**: `make fix-python-errors`
15+
**Markdown files**: `make fix-markdownlint && make fix-trailing-spaces`
16+
17+
### Before Committing
18+
19+
1. `make test` - Run test suite
20+
2. `make lint` - Check code quality
21+
3. `make check` - Combined lint + test
22+
23+
**Pre-commit hooks**: Install with `pre-commit install`
24+
25+
- Runs on push (skip with `git push --no-verify`)
26+
- Linters: golangci-lint, yamllint, markdownlint, ruff, shellcheck, vale, codespell
27+
- Skip specific hook: `SKIP=hook-name git push`
28+
29+
## Testing
30+
31+
- **Unit tests**: Use `gotest.tools/v3` (never testify)
32+
- **E2E tests**: Require specific setup - always ask user to run and copy output
33+
- **Gitea tests**: Most comprehensive and self-contained
34+
- **Commands**: `make test-no-cache`, `make html-coverage`
35+
36+
## Dependencies
37+
38+
- Add: `go get -u dependency`
39+
- **Always run after**: `make vendor` (required!)
40+
- Update Go version: `go mod tidy -go=1.20`
41+
- Remove unnecessary `replace` clauses in go.mod
42+
43+
## Documentation
44+
45+
- Preview: `make dev-docs` (<http://localhost:1313>)
46+
- Hugo with hugo-book theme
47+
- Custom shortcodes: `tech_preview`, `support_matrix`
48+
49+
## Useful Commands
50+
51+
- `make help` - Show all make targets
52+
- `make all` - Build, test, lint
53+
- `make clean` - Clean artifacts
54+
- `make fix-linters` - Auto-fix most linting issues
55+
56+
## Skills
57+
58+
For complex workflows, use these repo-local skills:
59+
60+
- **Commit messages**: Conventional commits with Jira integration, line length validation, required footers. Trigger: "create commit", "commit changes", "generate commit message"
61+
- **Jira tickets**: SRVKP story and bug templates with Jira markdown formatting. Trigger: "create Jira story", "create Jira bug", "SRVKP ticket"

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
TARGET_NAMESPACE=pipelines-as-code
2-
HUGO_VERSION=0.96.0
2+
HUGO_VERSION=0.146.0
33
GOLANGCI_LINT=golangci-lint
44
GOFUMPT=gofumpt
55
TKN_BINARY_NAME := tkn
@@ -199,8 +199,8 @@ download-hugo: ## Download hugo software
199199
./hack/download-hugo.sh $(HUGO_VERSION) $(TMPDIR)/hugo
200200

201201
.PHONY: dev-docs
202-
dev-docs: download-hugo ## preview live your docs with hugo
203-
@$(HUGO_BIN) server -s docs/ &
202+
dev-docs:
203+
@hugo server -s docs/ &
204204
@echo "Sleeping for 2s....";sleep 2 ; \
205205
if type -p xdg-open 2>/dev/null >/dev/null; then \
206206
xdg-open http://localhost:1313; \

docs/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
resources/_gen/
22
.hugo_build.lock
33
public/
4+
content/ALLVERSIONS
5+
content/VERSION
6+
tmp/

docs/_vendor/github.com/imfing/hextra/assets/css/chroma/dark.css

Lines changed: 89 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_vendor/github.com/imfing/hextra/assets/css/chroma/light.css

Lines changed: 90 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_vendor/github.com/imfing/hextra/assets/css/compiled/main.css

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)