[PR #2091] [MERGED] various doc updates in prep for 0.23 #2488

Closed
opened 2025-12-29 03:21:30 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2091
Author: @kradalby
Created: 8/30/2024
Status: Merged
Merged: 8/30/2024
Merged by: @kradalby

Base: mainHead: kradalby/0-23-docs


📝 Commits (5)

📊 Changes

6 files changed (+13 additions, -44 deletions)

View changed files

📝 config-example.yaml (+5 -0)
📝 docs/faq.md (+1 -1)
docs/glossary.md (+0 -6)
📝 docs/index.md (+1 -6)
📝 docs/running-headscale-container.md (+6 -30)
📝 mkdocs.yml (+0 -1)

📄 Description

Updates #2090

Summary by CodeRabbit

  • Documentation
    • Enhanced comments in the configuration file to clarify database options and guide users.
    • Updated FAQ to encourage users to submit feature requests instead of pull requests.
    • Streamlined contribution guidelines by directing users to the CONTRIBUTING.md file for detailed information.
    • Simplified instructions for running the Headscale container, focusing on essential steps and removing redundant content.
    • Removed the "Glossary" entry from the navigation structure, affecting access to glossary content.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/juanfont/headscale/pull/2091 **Author:** [@kradalby](https://github.com/kradalby) **Created:** 8/30/2024 **Status:** ✅ Merged **Merged:** 8/30/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `kradalby/0-23-docs` --- ### 📝 Commits (5) - [`5e3d512`](https://github.com/juanfont/headscale/commit/5e3d5121bd443cfc41d0b82286dab74fce32bb0a) various doc updates in prep for 0.23 - [`82c5aa9`](https://github.com/juanfont/headscale/commit/82c5aa9bdffbe0e5760c898751e4b753fd9153ee) add note discouraging postgresql - [`cd22edd`](https://github.com/juanfont/headscale/commit/cd22edd8c5f9cf54b817953f237456264dd69df1) Update docs/faq.md - [`0c43522`](https://github.com/juanfont/headscale/commit/0c4352216edbb203e17b86dd3bdb6535c319e770) remove entry for glossary in doc - [`244b3d4`](https://github.com/juanfont/headscale/commit/244b3d43d19be9bca2df5b8a0035833fcb3ba276) fix typo ### 📊 Changes **6 files changed** (+13 additions, -44 deletions) <details> <summary>View changed files</summary> 📝 `config-example.yaml` (+5 -0) 📝 `docs/faq.md` (+1 -1) ➖ `docs/glossary.md` (+0 -6) 📝 `docs/index.md` (+1 -6) 📝 `docs/running-headscale-container.md` (+6 -30) 📝 `mkdocs.yml` (+0 -1) </details> ### 📄 Description Updates #2090 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Enhanced comments in the configuration file to clarify database options and guide users. - Updated FAQ to encourage users to submit feature requests instead of pull requests. - Streamlined contribution guidelines by directing users to the CONTRIBUTING.md file for detailed information. - Simplified instructions for running the Headscale container, focusing on essential steps and removing redundant content. - Removed the "Glossary" entry from the navigation structure, affecting access to glossary content. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 03:21:30 +01:00
adam closed this issue 2025-12-29 03:21:30 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2488