Skip to content

Commit cef9d37

Browse files
committed
Update template
1 parent 0a5be0f commit cef9d37

8 files changed

Lines changed: 38 additions & 16 deletions

File tree

.github/workflows/cla.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
with:
5151
signed-commit-message: 'chore: $contributorName has signed the CLA'
5252
path-to-signatures: 'signatures/version1/cla.json'
53-
path-to-document: 'https://github.com/{{ github.repository }}/blob/master/docs/jekyll/_manual/developer-resources/cla.md' # e.g. a CLA or a DCO document
53+
path-to-document: 'https://github.com/{{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document
5454
# branch should not be protected
5555
branch: 'main'
5656
allowlist: "{{ cookiecutter.github_username }},github-actions[bot],dependabot[bot],bot*"

.github/workflows/jekyll-gh-pages.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,22 @@ jobs:
4747
steps:
4848
- name: Checkout
4949
uses: actions/checkout@v4
50+
- name: Set up Python
51+
uses: actions/setup-python@v5
52+
with:
53+
python-version: "3.11"
54+
- name: Install Python Tools
55+
run: |
56+
make install
5057
- name: Setup Ruby
5158
uses: ruby/setup-ruby@v1
5259
with:
5360
ruby-version: '3.3' # Recommended for Jekyll 4.4 in 2026
5461
bundler-cache: true # Runs 'bundle install' and caches gems automatically
5562
working-directory: ./docs/jekyll
63+
- name: Install Ruby Packages
64+
run: |
65+
make ruby-install
5666
- name: Setup Pages
5767
uses: actions/configure-pages@v5
5868
- name: Build with Jekyll site in /docs/jekyll

Makefile

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ TOML_FILE_LIST := ( \
230230
)
231231
# --------------------------------------------------
232232
.PHONY: \
233-
all list-folders venv install \
233+
all list-folders venv python-install \
234234
pre-commit-init security dependency-check black-formatter-check \
235235
black-formatter-fix render-cookiecutter jinja2-lint-check ruff-lint-check \
236236
ruff-lint-fix toml-lint-check yaml-lint-check format-check \
@@ -243,7 +243,7 @@ TOML_FILE_LIST := ( \
243243
# --------------------------------------------------
244244
# Default: run lint, typecheck, spellcheck, tests, & docs
245245
# --------------------------------------------------
246-
all: install lint-check typecheck spellcheck test build-docs
246+
all: python-install lint-check typecheck spellcheck test build-docs
247247
# --------------------------------------------------
248248
# Make Internal Utilities
249249
# --------------------------------------------------
@@ -269,7 +269,7 @@ venv:
269269
$(AT)$(CREATE_VENV)
270270
$(AT)echo "✅ Virtual environment created."
271271

272-
install: venv
272+
python-install: venv
273273
$(AT)echo "📦 Installing project dependencies..."
274274
$(AT)$(PIP) install --upgrade pip setuptools wheel
275275
# $(AT)$(PIP) install -e $(DEPS)
@@ -333,7 +333,8 @@ render-cookiecutter:
333333
$(AT)rm -rf $(RENDERED_COOKIE_DIR)
334334
$(AT)$(COOKIECUTTER) . --no-input \
335335
--output-dir $(RENDERED_COOKIE_DIR) \
336-
--overwrite-if-exists
336+
--overwrite-if-exists \
337+
--keep-project-on-failure
337338

338339
djlint-lint-check:
339340
$(AT)echo "🔍 djlint lint..."
@@ -414,6 +415,9 @@ test:
414415
# --------------------------------------------------
415416
# 📚 Documentation (Jekyll + nutrimatic)
416417
# --------------------------------------------------
418+
ruby-install:
419+
$(MAKE) -C $(JEKYLL_DIR) ruby-install;
420+
417421
jekyll:
418422
$(MAKE) -C $(JEKYLL_DIR) all;
419423

@@ -479,7 +483,7 @@ git-release:
479483
# 📢 Release
480484
# --------------------------------------------------
481485
pre-commit: test security dependency-check format-fix lint-check spellcheck typecheck
482-
pre-release: clean install pre-commit build-docs changelog build
486+
pre-release: clean python-install pre-commit build-docs changelog build
483487
release: git-release bump-version-patch
484488
# --------------------------------------------------
485489
# 🧹 Clean artifacts

docs/cookiecutter_input.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
"changelog": false,
2626
"git-init": false,
2727
"install": false,
28-
"pre-commit-init": false
28+
"pre-commit-init": false,
29+
"python-install": true
2930
}
3031
},
3132
"_is_sub_template": false,

docs/jekyll/Makefile

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,23 @@ PUBLISHDIR ?=
4141
# --------------------------------------------------
4242
# 📘 Documentation (Sphinx + Jekyll)
4343
# --------------------------------------------------
44+
RUBY_INSTALL := bundle install
4445
JEKYLL_BUILD := bundle exec jekyll build --quiet
4546
JEKYLL_CLEAN := bundle exec jekyll clean
4647
JEKYLL_SERVE := bundle exec jekyll serve
4748
# --------------------------------------------------
48-
.PHONY: all jekyll jekyll-serve build run clean help
49+
.PHONY: all ruby-install jekyll jekyll-serve build run clean help
4950
# --------------------------------------------------
5051
# Default:
5152
# --------------------------------------------------
5253
all: build
5354
# --------------------------------------------------
54-
# 📘 Documentation (Jekyll)
55+
# ♦️ Ruby
56+
# --------------------------------------------------
57+
ruby-install:
58+
$(AT)$(RUBY_INSTALL)
59+
# --------------------------------------------------
60+
# 📚 Documentation (Jekyll)
5561
# --------------------------------------------------
5662
jekyll:
5763
$(AT)echo "🔨 Building Jekyll site 📘..."
@@ -80,6 +86,7 @@ help:
8086
$(AT)echo " version: $(PACKAGE_VERSION)"
8187
$(AT)echo ""
8288
$(AT)echo "Usage:"
89+
$(AT)echo " make ruby-install Installs Gemfile packages."
8390
$(AT)echo " make build Generate Jekyll documentation"
8491
$(AT)echo " make run Serve Jekyll site locally"
8592
$(AT)echo " make clean Clean Jekyll build artifacts"

docs/jekyll/_manual/contribute/create-feature-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ After submitting your feature request, monitor the discussion. Answer questions
5454

5555
## Contributing the feature yourself
5656

57-
If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link create-pull-request.md %}).
57+
If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link _manual/contribute/create-pull-request.md %}).
5858

5959
We welcome community contributions and appreciate your help making github-docs-cookiecutter better!

docs/jekyll/_manual/contribute/create-pull-request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ Every contribution to github-docs-cookiecutter's software begins with a [pull re
1414
We know you're excited to create your first pull request. Before we get started, read these resources first:
1515

1616
- Get started [contributing to github-docs-cookiecutter]({{ site.repo_url }}/CONTRIBUTING.md).
17-
- Make sure your code follows the relevant [style guides]({% link style-guides/index.md %}).
18-
- It's recommended you [set up precommit hooks]({% link developer-guide.md %}) to auto-format when you commit.
17+
- Make sure your code follows the relevant [style guides]({% link _manual/contribute/style-guides/index.md %}).
18+
- It's recommended you [set up precommit hooks]({% link _manual/contribute/developer-guide.md %}) to auto-format when you commit.

docs/jekyll/_manual/contribute/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ We're excited that you're considering making a contribution to the github-docs-c
1010

1111
These are some good resources to explore for developers:
1212

13-
[Create a pull request]({% link create-pull-request.md %})
14-
[Create a feature request]({% link create-feature-request.md %})
15-
[Developer guide]({% link developer-guide.md %})
16-
[Merge a pull request]({% link merge-pull-request.md %})
13+
[Create a pull request]({% link _manual/contribute/create-pull-request.md %})
14+
[Create a feature request]({% link _manual/contribute/create-feature-request.md %})
15+
[Developer guide]({% link _manual/contribute/developer-guide.md %})
16+
[Merge a pull request]({% link _manual/contribute/merge-pull-request.md %})
1717
Find style guides for the github-docs-cookiecutter software project:

0 commit comments

Comments
 (0)