mirror of
https://github.com/esphome/esphome.git
synced 2026-06-24 13:45:15 +00:00
[docs] Update esphome-docs references to esphome.io after repo rename (#16705)
This commit is contained in:
@@ -29,7 +29,7 @@ Required fields:
|
|||||||
- **What does this implement/fix?**: Brief description of changes
|
- **What does this implement/fix?**: Brief description of changes
|
||||||
- **Types of changes**: Check ONE appropriate box (Bugfix, New feature, Breaking change, etc.)
|
- **Types of changes**: Check ONE appropriate box (Bugfix, New feature, Breaking change, etc.)
|
||||||
- **Related issue**: Use `fixes <link>` syntax if applicable
|
- **Related issue**: Use `fixes <link>` syntax if applicable
|
||||||
- **Pull request in esphome-docs**: Link if docs are needed
|
- **Pull request in esphome.io**: Link if docs are needed
|
||||||
- **Test Environment**: Check platforms you tested on
|
- **Test Environment**: Check platforms you tested on
|
||||||
- **Example config.yaml**: Include working example YAML
|
- **Example config.yaml**: Include working example YAML
|
||||||
- **Checklist**: Verify code is tested and tests added
|
- **Checklist**: Verify code is tested and tests added
|
||||||
@@ -54,9 +54,9 @@ Required fields:
|
|||||||
|
|
||||||
- fixes https://github.com/esphome/esphome/issues/XXX
|
- fixes https://github.com/esphome/esphome/issues/XXX
|
||||||
|
|
||||||
**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):**
|
**Pull request in [esphome.io](https://github.com/esphome/esphome.io) with documentation (if applicable):**
|
||||||
|
|
||||||
- esphome/esphome-docs#XXX
|
- esphome/esphome.io#XXX
|
||||||
|
|
||||||
## Test Environment
|
## Test Environment
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ component_name:
|
|||||||
- [x] Tests have been added to verify that the new code works (under `tests/` folder).
|
- [x] Tests have been added to verify that the new code works (under `tests/` folder).
|
||||||
|
|
||||||
If user exposed functionality or configuration variables are added/changed:
|
If user exposed functionality or configuration variables are added/changed:
|
||||||
- [ ] Documentation added/updated in [esphome-docs](https://github.com/esphome/esphome-docs).
|
- [ ] Documentation added/updated in [esphome.io](https://github.com/esphome/esphome.io).
|
||||||
```
|
```
|
||||||
|
|
||||||
## 5. Push and Create PR
|
## 5. Push and Create PR
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -2,7 +2,7 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Report an issue with the ESPHome documentation
|
- name: Report an issue with the ESPHome documentation
|
||||||
url: https://github.com/esphome/esphome-docs/issues/new/choose
|
url: https://github.com/esphome/esphome.io/issues/new/choose
|
||||||
about: Report an issue with the ESPHome documentation.
|
about: Report an issue with the ESPHome documentation.
|
||||||
- name: Report an issue with the ESPHome web server
|
- name: Report an issue with the ESPHome web server
|
||||||
url: https://github.com/esphome/esphome-webserver/issues/new/choose
|
url: https://github.com/esphome/esphome-webserver/issues/new/choose
|
||||||
|
|||||||
6
.github/PULL_REQUEST_TEMPLATE.md
vendored
6
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -16,9 +16,9 @@
|
|||||||
|
|
||||||
- fixes <link to issue>
|
- fixes <link to issue>
|
||||||
|
|
||||||
**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):**
|
**Pull request in [esphome.io](https://github.com/esphome/esphome.io) with documentation (if applicable):**
|
||||||
|
|
||||||
- esphome/esphome-docs#<esphome-docs PR number goes here>
|
- esphome/esphome.io#<esphome.io PR number goes here>
|
||||||
|
|
||||||
## Test Environment
|
## Test Environment
|
||||||
|
|
||||||
@@ -43,4 +43,4 @@
|
|||||||
- [ ] Tests have been added to verify that the new code works (under `tests/` folder).
|
- [ ] Tests have been added to verify that the new code works (under `tests/` folder).
|
||||||
|
|
||||||
If user exposed functionality or configuration variables are added/changed:
|
If user exposed functionality or configuration variables are added/changed:
|
||||||
- [ ] Documentation added/updated in [esphome-docs](https://github.com/esphome/esphome-docs).
|
- [ ] Documentation added/updated in [esphome.io](https://github.com/esphome/esphome.io).
|
||||||
|
|||||||
3
.github/scripts/auto-label-pr/constants.js
vendored
3
.github/scripts/auto-label-pr/constants.js
vendored
@@ -35,6 +35,9 @@ module.exports = {
|
|||||||
],
|
],
|
||||||
|
|
||||||
DOCS_PR_PATTERNS: [
|
DOCS_PR_PATTERNS: [
|
||||||
|
/https:\/\/github\.com\/esphome\/esphome\.io\/pull\/\d+/,
|
||||||
|
/esphome\/esphome\.io#\d+/,
|
||||||
|
// Keep matching the old esphome-docs name during the transition period
|
||||||
/https:\/\/github\.com\/esphome\/esphome-docs\/pull\/\d+/,
|
/https:\/\/github\.com\/esphome\/esphome-docs\/pull\/\d+/,
|
||||||
/esphome\/esphome-docs#\d+/
|
/esphome\/esphome-docs#\d+/
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -462,7 +462,7 @@ This document provides essential context for AI models interacting with this pro
|
|||||||
6. **Pull Request:** Submit a PR against the `dev` branch. The Pull Request title should have a prefix of the component being worked on (e.g., `[display] Fix bug`, `[abc123] Add new component`). Update documentation, examples, and add `CODEOWNERS` entries as needed. Pull requests should always be made using the `.github/PULL_REQUEST_TEMPLATE.md` template - fill out all sections completely without removing any parts of the template.
|
6. **Pull Request:** Submit a PR against the `dev` branch. The Pull Request title should have a prefix of the component being worked on (e.g., `[display] Fix bug`, `[abc123] Add new component`). Update documentation, examples, and add `CODEOWNERS` entries as needed. Pull requests should always be made using the `.github/PULL_REQUEST_TEMPLATE.md` template - fill out all sections completely without removing any parts of the template.
|
||||||
|
|
||||||
* **Documentation Contributions:**
|
* **Documentation Contributions:**
|
||||||
* Documentation is hosted in the separate `esphome/esphome-docs` repository.
|
* Documentation is hosted in the separate `esphome/esphome.io` repository.
|
||||||
* The contribution workflow is the same as for the codebase.
|
* The contribution workflow is the same as for the codebase.
|
||||||
* When editing a component's documentation page, also update the corresponding component index page to ensure both pages remain in sync.
|
* When editing a component's documentation page, also update the corresponding component index page to ensure both pages remain in sync.
|
||||||
|
|
||||||
@@ -681,7 +681,7 @@ This document provides essential context for AI models interacting with this pro
|
|||||||
- [ ] Explored non-breaking alternatives
|
- [ ] Explored non-breaking alternatives
|
||||||
- [ ] Added deprecation warnings if possible (use `ESPDEPRECATED` macro for C++)
|
- [ ] Added deprecation warnings if possible (use `ESPDEPRECATED` macro for C++)
|
||||||
- [ ] Documented migration path in PR description with before/after examples
|
- [ ] Documented migration path in PR description with before/after examples
|
||||||
- [ ] Updated all internal usage and esphome-docs
|
- [ ] Updated all internal usage and esphome.io
|
||||||
- [ ] Tested backward compatibility during deprecation period
|
- [ ] Tested backward compatibility during deprecation period
|
||||||
|
|
||||||
* **Deprecation Pattern (C++):**
|
* **Deprecation Pattern (C++):**
|
||||||
|
|||||||
Reference in New Issue
Block a user