From 197a3df9f92297ccdd643841cf1fd9dd58116a22 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 31 Jan 2026 16:35:51 -0800 Subject: [PATCH] Feat 022 (#59) * fix(docs): Fix for index file to ensure description doesn't mess with page header. * feat(docs): Fun emojis added to template readme. * feat(docs): Main page documentation updates. * feat(docs): readme updates. * chore(update): Update template from cookiecutter-cookiecutter --- .../community_health_files/__init__.j2 | 2 + .../community_health_files/code_of_conduct.j2 | 2 + .../community_health_files/codeowners.j2 | 2 + .../community_health_files/contributing.j2 | 2 + .../community_health_files/funding.j2 | 2 + .../issue_template/01-bug-report.j2 | 2 + .../issue_template/02-feature-request.j2 | 2 + .../issue_template/__init__.j2 | 3 ++ .../issue_template/config.j2 | 2 + .../issue_template/z-developer-issue.j2 | 2 + .../pull_request_template.j2 | 2 + .../01-default-pull-request.j2 | 2 + .../pull_request_template/02-bug-fix.j2 | 2 + .../03-feature-request.j2 | 2 + .../pull_request_template/__init__.j2 | 2 + .../community_health_files/security.j2 | 2 + .../community_health_files/support.j2 | 2 + .cookiecutter_includes/workflows/__init__.j2 | 3 ++ .../workflows/contributor-assistant.j2 | 2 + .../workflows/dependency-check.j2 | 2 + .../workflows/format-check.j2 | 2 + .../workflows/jekyll-gh-pages.j2 | 2 + .../workflows/lint-check.j2 | 2 + .../workflows/security-audit.j2 | 2 + .../workflows/spellcheck.j2 | 2 + .cookiecutter_includes/workflows/tests.j2 | 2 + .cookiecutter_includes/workflows/typecheck.j2 | 2 + .github/CONTRIBUTING.md | 2 +- .github/SUPPORT.md | 2 +- .github/workflows/cla.yml | 24 ++++----- README.md | 49 ++++++++++++++++--- changelogs/CHANGELOG.md | 19 ++++++- changelogs/releases/v0.1.1.md | 21 ++++++-- docs/jekyll/README.md | 41 +++++++++++++--- docs/jekyll/docs/cookiecutter_input.json | 2 +- {{ cookiecutter.project_slug }}/README.md | 12 +++-- {{ cookiecutter.project_slug }}/index.md | 4 +- 37 files changed, 191 insertions(+), 41 deletions(-) create mode 100644 .cookiecutter_includes/community_health_files/__init__.j2 create mode 100644 .cookiecutter_includes/community_health_files/code_of_conduct.j2 create mode 100644 .cookiecutter_includes/community_health_files/codeowners.j2 create mode 100644 .cookiecutter_includes/community_health_files/contributing.j2 create mode 100644 .cookiecutter_includes/community_health_files/funding.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/__init__.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/config.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 create mode 100644 .cookiecutter_includes/community_health_files/security.j2 create mode 100644 .cookiecutter_includes/community_health_files/support.j2 create mode 100644 .cookiecutter_includes/workflows/__init__.j2 create mode 100644 .cookiecutter_includes/workflows/contributor-assistant.j2 create mode 100644 .cookiecutter_includes/workflows/dependency-check.j2 create mode 100644 .cookiecutter_includes/workflows/format-check.j2 create mode 100644 .cookiecutter_includes/workflows/jekyll-gh-pages.j2 create mode 100644 .cookiecutter_includes/workflows/lint-check.j2 create mode 100644 .cookiecutter_includes/workflows/security-audit.j2 create mode 100644 .cookiecutter_includes/workflows/spellcheck.j2 create mode 100644 .cookiecutter_includes/workflows/tests.j2 create mode 100644 .cookiecutter_includes/workflows/typecheck.j2 diff --git a/.cookiecutter_includes/community_health_files/__init__.j2 b/.cookiecutter_includes/community_health_files/__init__.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/__init__.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/code_of_conduct.j2 b/.cookiecutter_includes/community_health_files/code_of_conduct.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/code_of_conduct.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/codeowners.j2 b/.cookiecutter_includes/community_health_files/codeowners.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/codeowners.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/contributing.j2 b/.cookiecutter_includes/community_health_files/contributing.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/contributing.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/funding.j2 b/.cookiecutter_includes/community_health_files/funding.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/funding.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 b/.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 b/.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/issue_template/__init__.j2 b/.cookiecutter_includes/community_health_files/issue_template/__init__.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/__init__.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/community_health_files/issue_template/config.j2 b/.cookiecutter_includes/community_health_files/issue_template/config.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/config.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 b/.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/pull_request_template.j2 b/.cookiecutter_includes/community_health_files/pull_request_template.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/security.j2 b/.cookiecutter_includes/community_health_files/security.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/security.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/community_health_files/support.j2 b/.cookiecutter_includes/community_health_files/support.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/support.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/__init__.j2 b/.cookiecutter_includes/workflows/__init__.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/workflows/__init__.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/workflows/contributor-assistant.j2 b/.cookiecutter_includes/workflows/contributor-assistant.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/contributor-assistant.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/dependency-check.j2 b/.cookiecutter_includes/workflows/dependency-check.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/dependency-check.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/format-check.j2 b/.cookiecutter_includes/workflows/format-check.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/format-check.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/jekyll-gh-pages.j2 b/.cookiecutter_includes/workflows/jekyll-gh-pages.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/jekyll-gh-pages.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/lint-check.j2 b/.cookiecutter_includes/workflows/lint-check.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/lint-check.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/security-audit.j2 b/.cookiecutter_includes/workflows/security-audit.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/security-audit.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/spellcheck.j2 b/.cookiecutter_includes/workflows/spellcheck.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/spellcheck.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/tests.j2 b/.cookiecutter_includes/workflows/tests.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/tests.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/workflows/typecheck.j2 b/.cookiecutter_includes/workflows/typecheck.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/workflows/typecheck.j2 @@ -0,0 +1,2 @@ + + diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7f8203b..54306a7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 1394c3f..9e6b6f5 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -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: diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index e3a2406..2239006 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -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 @@ -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 diff --git a/README.md b/README.md index af8d4bf..a0bc0b7 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,46 @@

Overview

Github docs cookiecutter template generation.

-

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. 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. Skip the boring boilerplate code and get to the work that matters.

-

CI/CD Check List:

+

Utilizes:
+The github-docs-cookiecutter depends on the following repositories for its documentation and sub-features.

+ + + +

Maintains:
+The github-docs-cookiecutter is used to maintain documentation for the following projects.

+ +

Cookiecutter Projects:

+ + +

Python Projects:

+ + +

Ansible Projects:

+ + +
+ +

πŸ› οΈ CI/CD Check List: