dev: new way to fill the documentation (#5986)

Author: ldez

.github/workflows/deploy-documentation.yml

@@ -31,19 +31,8 @@ jobs:
           wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
           && sudo dpkg -i ${{ runner.temp }}/hugo.deb
 
-      - name: Build Documentation assets
-        run: make website_copy_jsonschema website_expand_templates
-
       - name: Build Documentation
-        env:
-          # For maximum backward compatibility with Hugo modules
-          HUGO_ENVIRONMENT: production
-          HUGO_ENV: production
-        working-directory: ./docs
-        run: |
-          hugo \
-            --gc --minify \
-            --baseURL "https://golangci-lint.run/"
+        run: make docs_build
 
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4

.github/workflows/pr-documentation.yml

@@ -31,12 +31,4 @@ jobs:
           && sudo dpkg -i ${{ runner.temp }}/hugo.deb
 
       - name: Build Documentation
-        env:
-          # For maximum backward compatibility with Hugo modules
-          HUGO_ENVIRONMENT: production
-          HUGO_ENV: production
-        working-directory: ./docs
-        run: |
-          hugo \
-            --gc --minify \
-            --baseURL "https://golangci-lint.run/"
+        run: make docs_build

CHANGELOG.md

@@ -6,6 +6,8 @@ If you value it, consider supporting us, we appreciate it!
 
 [![Donate](https://img.shields.io/badge/Donate-❤️-blue?style=for-the-badge)](https://donate.golangci.org)
 
+<!-- START --->
+
 ### v2.3.1
 
 1. Linters bug fixes

Makefile

@@ -101,18 +101,18 @@ go.sum: go.mod
 
 # Documentation
 
-docs_serve:
+docs_serve: website_expand_templates
 	@make -C ./docs serve
 .PHONY: docs_serve
 
-docs_reset:
-	@make -C ./docs reset
-.PHONY: docs_reset
-
 docs_clean:
 	@make -C ./docs clean
 .PHONY: docs_clean
 
+docs_build: website_copy_jsonschema website_expand_templates
+	@make -C ./docs build
+.PHONY: docs_build
+
 docs/static/demo.gif: FORCE
 	vhs docs/golangci-lint.tape
 

README.md

@@ -27,7 +27,7 @@ Documentation is hosted at https://golangci-lint.run.
 [![Follow on Bluesky](https://img.shields.io/badge/Bluesky-0a7aff?logo=bluesky&logoColor=white)](https://bsky.app/profile/golangci-lint.run)
 [![Follow on Twitter](https://img.shields.io/badge/Twitter-1DA1F2?logo=x&logoColor=white)](https://twitter.com/golangci)
 
-## Supporting Us
+## Support Us
 
 [![Open Collective backers and sponsors](https://img.shields.io/badge/OpenCollective-Donate-blue?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint)
 [![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci)

assets/cli-help.json

@@ -1,4 +1,9 @@
+# Hugo files
 .hugo_build.lock
 public/
-/static/jsonschema/
 resources/
+
+# Generated files
+/static/jsonschema/
+data/version.json
+.tmp/

docs/.gitignore

@@ -1,12 +1,17 @@
-.PHONY: default clean reset serve
+.PHONY: default clean serve build
 
 default: clean serve
 
 clean:
 	rm -rf public/
 
-reset:
-	git checkout HEAD content/
-
 serve: clean
-	hugo server --disableFastRender --buildDrafts --enableGitInfo --watch --source .
+	hugo server --disableFastRender --buildDrafts --enableGitInfo
+
+# IMPORTANT used by the CI to deploy documentation
+build: clean
+	HUGO_ENVIRONMENT=production \
+	HUGO_ENV=production \
+	hugo \
+		--gc --minify \
+		--baseURL "https://golangci-lint.run/"

docs/Makefile

@@ -8,3 +8,11 @@
 .hx-line-clamp-3.hextra-card-subtitle {
   -webkit-line-clamp: 30;
 }
+
+.author-cards {
+    grid-template-columns: repeat(auto-fill, minmax(max(150px, calc((100% - 1rem * 4) / var(--hextra-cards-grid-cols))), 1fr));
+}
+
+.gl-hidden {
+    display: none;
+}

docs/assets/css/custom.css

@@ -26,15 +26,13 @@ title: 'Golangci-lint Documentation'
     icon="arrow-circle-right" >}}
 {{< /cards >}}
 
-
-## Supporting Us
+## Support Us
 
 Golangci-lint is a free and open-source project built by volunteers.
 
 If you value it, consider supporting us, we appreciate it!
 
-<div class="hx-mb-6"></div>
-<div class="hx-mb-6">
+<div class="hx-mt-6 hx-mb-6">
 {{< hextra/hero-button text="Donate ❤️" link="https://donate.golangci.org" >}}
 </div>