diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 286f73d..1394c3f 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -3,14 +3,14 @@ Thank you for using the github-docs-cookiecutter project! To help us maintain it efficiently, please check these resources before opening an issue. ## 🛠️ Getting Help -* **Documentation:** Start by reading our [Project Wiki](https://jcook3701.github.io/github-docs-cookiecutter). -* **FAQ:** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/github-docs-cookiecutter/manual/troubleshooting/faq). -* **Community Forums:** For general questions and "how-to" help, please use [GitHub Discussions](https://github.com/jcook3701/github-docs-cookiecutter/discussions) instead of Issues. +* **Documentation:** Start by reading our [Project Wiki](https://jcook3701.github.io/github-docs-cookiecutter). +* **FAQ:** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/github-docs-cookiecutter/manual/troubleshooting/faq). +* **Community Forums:** For general questions and "how-to" help, please use [GitHub Discussions](https://github.com/jcook3701/github-docs-cookiecutter/discussions) instead of Issues. ## 🐛 Reporting Bugs If you have found a bug, please: -1. Search existing [Issues](https://github.com/jcook3701/github-docs-cookiecutter/issues?state=open) to see if it has already been reported. -2. Follow the [bug report template](ISSUE_TEMPLATE/01-bug-report.yml) to provide a reproducible example. +1. Search existing [Issues](https://github.com/jcook3701/github-docs-cookiecutter/issues?state=open) to see if it has already been reported. +2. Follow the [bug report template](ISSUE_TEMPLATE/01-bug-report.yml) to provide a reproducible example. ## 🔒 Security Vulnerabilities Please **do not** report security vulnerabilities via public issues. Instead, follow our [Security Policy](https://github.com/jcook3701/github-docs-cookiecutter/blob/master/.github/SECURITY.md) to report them privately. @@ -22,8 +22,8 @@ This is an open-source project maintained by volunteers. We try to respond withi github-docs-cookiecutter is an open-source project maintained by volunteers. Your financial support helps sustain the project by covering: -* **Infrastructure costs:** Domain names, hosting, and CI/CD services. -* **Time:** Allowing maintainers to dedicate more time to bug fixes and new features. +* **Infrastructure costs:** Domain names, hosting, and CI/CD services. +* **Time:** Allowing maintainers to dedicate more time to bug fixes and new features. If this project has helped you, please consider supporting us through one of the following methods: -* **[Buy Me a Coffee](https://buymeacoffee.com/jcook3701):** A simple way to provide a one-time donation. +* **[Buy Me a Coffee](https://buymeacoffee.com/jcook3701):** A simple way to provide a one-time donation. We greatly appreciate your support! diff --git a/.jinja-runtime.json b/.jinja-runtime.json index b7cd767..c846ff2 100644 --- a/.jinja-runtime.json +++ b/.jinja-runtime.json @@ -3,7 +3,7 @@ "search_paths": [ ".", "./.cookiecutter_includes", - "./github-docs-cookiecutter" + "./{{ cookiecutter.project_slug }}" ], "base_dir": "." }, diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index d0551db..a04db31 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -190,10 +190,22 @@ Feat 016 (#47) - Merge pull request #50 from jcook3701/develop Feat 017 (#49) +- Feat 018 (#51) + +* chore(update): Update template using ```cookiecutter_project_upgrader``` from cookiecutter-cookiecutter. +- Merge pull request #52 from jcook3701/develop + +Feat 018 (#51) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. +- *(cla)* Removed signatures folder as it should be re-generated as cla/v1/signatures.json. +- *(configuration)* Update to template_type configuration. + +### 🚀 Added + +- *(docs)* Minor documentation update. ## [0.1.0] - 2025-12-05 ### ⚙️ Miscellaneous diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md index 9c1cef9..536a087 100644 --- a/changelogs/releases/v0.1.1.md +++ b/changelogs/releases/v0.1.1.md @@ -2,7 +2,7 @@ # Changelog: # -------------------------------------------------- -## [0.1.1] - 2026-01-29 +## [0.1.1] - 2026-01-30 ### ⚙️ Miscellaneous @@ -190,7 +190,19 @@ Feat 016 (#47) - Merge pull request #50 from jcook3701/develop Feat 017 (#49) +- Feat 018 (#51) + +* chore(update): Update template using ```cookiecutter_project_upgrader``` from cookiecutter-cookiecutter. +- Merge pull request #52 from jcook3701/develop + +Feat 018 (#51) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. +- *(cla)* Removed signatures folder as it should be re-generated as cla/v1/signatures.json. +- *(configuration)* Update to template_type configuration. + +### 🚀 Added + +- *(docs)* Minor documentation update. diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 7e4f101..6973f0d 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -58,7 +58,7 @@ "publication_year": "2025", "python_version": "3.11", "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", - "template_type": "cookiecutter", + "template_type": "documentation", "theme": "just-the-docs/just-the-docs@v0.11.0", "timezone": "America/Los_Angeles", "twitter_username": "", diff --git a/signatures/version1/cla.json b/signatures/version1/cla.json deleted file mode 100644 index 18d5487..0000000 --- a/signatures/version1/cla.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "signedContributors": [] -} \ No newline at end of file diff --git a/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md b/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md index fa25f41..3f6ba7d 100644 --- a/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md @@ -6,4 +6,4 @@ has_children: true --- ## Troubleshooting {{ cookiecutter.project_name }} -* **[FAQ]({% raw %}{% link _manual/troubleshooting/faq.md %}{% endraw %})** Common questions are answered in our [Frequently Asked Questions]({{ cookiecutter.github_io }}/manual/troubleshooting/faq.md). +* **[FAQ]({% raw %}{% link _manual/troubleshooting/faq.md %}{% endraw %})** Common questions are answered in our Frequently Asked Questions