Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .cookiecutter_includes/community_health_files/__init__.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/community_health_files/codeowners.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/community_health_files/funding.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@



Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/community_health_files/security.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/community_health_files/support.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


3 changes: 3 additions & 0 deletions .cookiecutter_includes/workflows/__init__.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@



2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/contributor-assistant.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/dependency-check.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/format-check.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/jekyll-gh-pages.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/lint-check.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/security-audit.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/spellcheck.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/tests.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 2 additions & 0 deletions .cookiecutter_includes/workflows/typecheck.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ There are three important things to know:
Due to legal reasons, contributors will be asked to accept a [CLA](https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla) before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) as can be found below.

* [ICLA](https://www.apache.org/licenses/icla.pdf)
* [CCLA](https://www.apache.org/licenses/cla-corporate.pdf).
* [CCLA](https://www.apache.org/licenses/cla-corporate.pdf).

### Contribution Content Guidelines

Expand Down
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ github-docs-cookiecutter is an open-source project maintained by volunteers. You

If this project has helped you, please consider supporting us through one of the following methods:
<!-- TODO:
Look into GitHub Sponsors:
Look into GitHub Sponsors:
* **[GitHub Sponsors](URL_HERE):** Ideal for recurring, direct support.
* **[Open Collective](URL_HERE):** Best for corporate sponsorship and transparent expense management.
-->
Expand Down
24 changes: 12 additions & 12 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ on:
synchronize
]

# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
# explicitly configure permissions, in case your GITHUB_TOKEN
# workflow permissions are set to read-only in repository settings
permissions:
actions: write
contents: write # this can be 'read' if the signatures are in remote repository
Expand All @@ -39,26 +40,25 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: "CLA Assistant"
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
if: >-
(github.event.comment.body == 'recheck' ||
github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') ||
github.event_name == 'pull_request_target'
uses: contributor-assistant/github-action@v2.6.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # the below token should have repo scope and must be manually added by you in the repository's secret
# This token is required only if you have configured to store the signatures in a remote repository/organization
# PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
path-to-signatures: "cla/v1/signatures.json"
path-to-document: "https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla" # e.g. a CLA or a DCO document
path-to-document: "https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla"
# branch should not be protected
branch: "master" # Should match the branch that github pages are hosted from.
allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*"

# the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
# remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
# remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository)
# If the below optional inputs are not given, then default values will be taken:
create-file-commit-message: "chore(CLA): Creating file for storing CLA Signatures."
signed-commit-message: "chore(CLA): $contributorName has signed the CLA."
# custom-notsigned-prcomment: "pull request comment with Introductory message to ask new contributors to sign"
# custom-pr-sign-comment: "The signature to be committed in order to sign the CLA"
# custom-allsigned-prcomment: "pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA."
# lock-pullrequest-aftermerge: false - if you don"t want this bot to automatically lock the pull request after merging (default - true)
use-dco-flag: False # If you are using DCO instead of CLA
# custom-allsigned-prcomment: "**CLA Assistant Lite bot** All Contributors have signed the CLA."
lock-pullrequest-aftermerge: true
use-dco-flag: false # If you are using DCO instead of CLA
49 changes: 42 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,46 @@
<h2 id="overview">Overview</h2>
<p>Github docs cookiecutter template generation.</p>

<p>Template cookiecutter project for Github Pages (Jekyll). This project can utilize a variety of different documentation templates but is focused mainly on a clean implementation of <a href="https://github.com/just-the-docs/just-the-docs">just the docs</a>. Skip the boring boilerplate code and get to the work that matters.</p>
<p>Template cookiecutter project for <strong>Github Pages</strong> (Jekyll). This project can utilize a variety of different documentation templates but is focused mainly on a clean implementation of <strong><a href="https://github.com/just-the-docs/just-the-docs">just the docs</a></strong>. Skip the boring <strong>boilerplate code</strong> and get to the work that matters.</p>

<hr />

<p><strong>CI/CD Check List:</strong></p>
<p><strong>Utilizes:</strong><br />
The <strong>github-docs-cookiecutter</strong> depends on the following repositories for its documentation and sub-features.</p>

<ul>
<li><strong><a href="https://github.com/jcook3701/cookiecutter-cookiecutter">cookiecutter-cookiecutter</a></strong> Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.</li>
<li><strong><a href="https://github.com/jcook3701/github-docs-cookiecutter">Github docs</a></strong> via the cookiecutter-cookiecutter this project is used as a sub-template to generate documentation.</li>
<li><strong><a href="https://github.com/jcook3701/nutri-matic">Nutri-Matic</a></strong> cookiecutter hooks and tools for documentation build. The nutrimatic package has become a .</li>
</ul>

<p><strong>Maintains:</strong><br />
The <strong>github-docs-cookiecutter</strong> is used to maintain documentation for the following projects.</p>

<p><strong>Cookiecutter Projects:</strong></p>
<ul>
<li><strong><a href="https://github.com/jcook3701/cookiecutter-cookiecutter">cookiecutter-cookiecutter</a></strong></li>
<li><strong><a href="https://github.com/jcook3701/python3-cookiecutter">python3-cookiecutter</a></strong></li>
<li><strong><a href="https://github.com/jcook3701/ansible-galaxy-cookiecutter">ansible-galaxy-cookiecutter</a></strong></li>
</ul>

<p><strong>Python Projects:</strong></p>
<ul>
<li><strong><a href="https://github.com/jcook3701/nutri-matic">Nutri-Matic</a></strong></li>
</ul>

<p><strong>Ansible Projects:</strong></p>
<ul>
<li><strong><a href="https://github.com/jcook3701/jcook3701.docker">jcook3701.docker</a></strong> Ansible Galaxy collection used to install docker packages.</li>
<li><strong><a href="https://github.com/jcook3701/jcook3701.flatpak">jcook3701.flatpak</a></strong> Ansible Galaxy collection used to install flatpak packages.</li>
<li><strong><a href="https://github.com/jcook3701/jcook3701.pkgs">jcook3701.pkgs</a></strong> Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.</li>
<li><strong><a href="https://github.com/jcook3701/jcook3701.source">jcook3701.source</a></strong> Ansible Galaxy collection used to install packages from source code.</li>
<li><strong><a href="https://github.com/jcook3701/jcook3701.snap">jcook3701.snap</a></strong> Ansible Galaxy collection used to install snap packages.</li>
</ul>

<hr />

<p>🛠️ <strong>CI/CD Check List:</strong></p>

<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
<ul>
Expand Down Expand Up @@ -56,18 +91,18 @@

<hr />

<h2 id="getting-started">Getting Started</h2>
<h2 id="-getting-started">🌱 Getting Started</h2>

<ul>
<li><a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/setup-guide/requirements">Requirements</a></li>
<li><a href="https://jcook3701.github.io/github-docs-cookiecutter/manual/introduction/installation-guide">Installation guide</a></li>
</ul>

<h2 id="documentation">Documentation</h2>
<h2 id="-documentation">📚 Documentation</h2>

<p>The github-docs-cookiecutter documentation is available at <a href="https://jcook3701.github.io/github-docs-cookiecutter">docs</a>.</p>

<h2 id="contributing">Contributing</h2>
<h2 id="-contributing">🤝 Contributing</h2>

<p>If you’re interested in contributing to the github-docs-cookiecutter project:</p>
<ul>
Expand All @@ -78,13 +113,13 @@

<hr />

<h2 id="authors-notes">Authors Notes</h2>
<h2 id="-authors-notes">🍹 Authors Notes</h2>

<ol>
<li>This code currently works with cookiecutter (2.6) from PyPi repositories.</li>
</ol>

<h2 id="license">License</h2>
<h2 id="️-license">⚖️ License</h2>

<p>Copyright (c) 2025-2026, Jared Cook</p>

Expand Down
19 changes: 17 additions & 2 deletions changelogs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,15 +221,30 @@ Feat 019 (#53)
- Merge pull request #56 from jcook3701/develop

Feat 020 (#55)
- Feat 021 (#57)

* fix(upgrader): Fix to move project back to cookiecutter template project.

* chore(update): Update template from cookiecutter-cookiecutter using cookiecutter_project_upgrader.

* feat(upgrader): Updates to upgrader configuration file to fix hooks upgrade.
- Merge pull request #58 from jcook3701/develop

Feat 021 (#57)

### 🐛 Fixed

- *(template)* Updates to template cookiecutter.json file.
- *(upgrader)* Fix to move project back to cookiecutter template project.
- *(docs)* Fix for index file to ensure description doesn't mess with page header.

### 🚀 Added

- *(upgrader)* Updates to upgrader configuration file to fix hooks upgrade.
- *(docs)* Fun emojis added to template readme.
- *(docs)* Main page documentation updates.
- *(docs)* Readme updates.
- *(docs)* Readme updates.
- *(docs)* Readme updates.
- *(docs)* Readme updates.
## [0.1.0] - 2025-12-05

### ⚙️ Miscellaneous
Expand Down
21 changes: 18 additions & 3 deletions changelogs/releases/v0.1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Changelog:
# --------------------------------------------------

## [0.1.1] - 2026-01-30
## [0.1.1] - 2026-02-01

### ⚙️ Miscellaneous

Expand Down Expand Up @@ -221,12 +221,27 @@ Feat 019 (#53)
- Merge pull request #56 from jcook3701/develop

Feat 020 (#55)
- Feat 021 (#57)

* fix(upgrader): Fix to move project back to cookiecutter template project.

* chore(update): Update template from cookiecutter-cookiecutter using cookiecutter_project_upgrader.

* feat(upgrader): Updates to upgrader configuration file to fix hooks upgrade.
- Merge pull request #58 from jcook3701/develop

Feat 021 (#57)

### 🐛 Fixed

- *(template)* Updates to template cookiecutter.json file.
- *(upgrader)* Fix to move project back to cookiecutter template project.
- *(docs)* Fix for index file to ensure description doesn't mess with page header.

### 🚀 Added

- *(upgrader)* Updates to upgrader configuration file to fix hooks upgrade.
- *(docs)* Fun emojis added to template readme.
- *(docs)* Main page documentation updates.
- *(docs)* Readme updates.
- *(docs)* Readme updates.
- *(docs)* Readme updates.
- *(docs)* Readme updates.
41 changes: 34 additions & 7 deletions docs/jekyll/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,38 @@
## Overview
{{ site.description }}

Template cookiecutter project for Github Pages (Jekyll). This project can utilize a variety of different documentation templates but is focused mainly on a clean implementation of [just the docs](https://github.com/just-the-docs/just-the-docs). Skip the boring boilerplate code and get to the work that matters.
Template cookiecutter project for **Github Pages** (Jekyll). This project can utilize a variety of different documentation templates but is focused mainly on a clean implementation of **[just the docs](https://github.com/just-the-docs/just-the-docs)**. Skip the boring **boilerplate code** and get to the work that matters.

***

**CI/CD Check List:**
**Utilizes:**
The **{{ site.title }}** depends on the following repositories for its documentation and sub-features.

* **[cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter)** Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.
* **[Github docs](https://github.com/jcook3701/github-docs-cookiecutter)** via the cookiecutter-cookiecutter this project is used as a sub-template to generate documentation.
* **[Nutri-Matic](https://github.com/jcook3701/nutri-matic)** cookiecutter hooks and tools for documentation build. The nutrimatic package has become a .

**Maintains:**
The **{{ site.title }}** is used to maintain documentation for the following projects.

**Cookiecutter Projects:**
* **[cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter)**
* **[python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter)**
* **[ansible-galaxy-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter)**

**Python Projects:**
* **[Nutri-Matic](https://github.com/jcook3701/nutri-matic)**

**Ansible Projects:**
* **[jcook3701.docker](https://github.com/jcook3701/jcook3701.docker)** Ansible Galaxy collection used to install docker packages.
* **[jcook3701.flatpak](https://github.com/jcook3701/jcook3701.flatpak)** Ansible Galaxy collection used to install flatpak packages.
* **[jcook3701.pkgs](https://github.com/jcook3701/jcook3701.pkgs)** Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.
* **[jcook3701.source](https://github.com/jcook3701/jcook3701.source)** Ansible Galaxy collection used to install packages from source code.
* **[jcook3701.snap](https://github.com/jcook3701/jcook3701.snap)** Ansible Galaxy collection used to install snap packages.

***

🛠️ **CI/CD Check List:**

<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
* ![dependency-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg)
Expand Down Expand Up @@ -47,16 +74,16 @@ Utilization of [nutri-matic](https://github.com/jcook3701/nutri-matic) is the op

***

## Getting Started
## 🌱 Getting Started

* [Requirements]({{ site.github_io_url }}/manual/setup-guide/requirements)
* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide)

## Documentation
## 📚 Documentation

The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}).

## Contributing
## 🤝 Contributing

If you're interested in contributing to the {{ site.title }} project:
* Start by reading the [contributing guide]({{ site.github_io_url }}/manual/developer-resources/contribute).
Expand All @@ -65,11 +92,11 @@ If you're interested in contributing to the {{ site.title }} project:

***

## Authors Notes
## 🍹 Authors Notes

1. This code currently works with cookiecutter (2.6) from PyPi repositories.

## License
## ⚖️ License

{{ site.copyright }}

Expand Down
2 changes: 1 addition & 1 deletion docs/jekyll/docs/cookiecutter_input.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"__year_range": "2025-2026",
"_checkout": "master",
"_checkout": null,
"_copy_without_render": [
"README.md",
"_includes/*"
Expand Down
Loading
Loading