mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-08 09:56:30 +00:00
Use absolute paths for IQS links (#2489)
This commit is contained in:
Abílio Costa
GitHub
parent
6aa5ec2f8c
commit
c02d517f60
@ -13,10 +13,11 @@ export default function RuleOverview({tier}) {
|
||||
if (typeof rule === "object") {
|
||||
id = rule.id;
|
||||
}
|
||||
const absoluteRulePath = `/docs/core/integration-quality-scale/rules/${id}`;
|
||||
const relatedRule = docs[`core/integration-quality-scale/rules/${id}`];
|
||||
return (
|
||||
<li key={id}>
|
||||
<Link to={`rules/${id}`}>{id}</Link> - {relatedRule.title}
|
||||
<Link to={absoluteRulePath}>{id}</Link> - {relatedRule.title}
|
||||
</li>
|
||||
);
|
||||
})}
|
||||
|
||||
@ -94,7 +94,7 @@ Home Assistant encourages our contributors to get their integrations to the high
|
||||
|
||||
When an integration reaches the minimum requirements for a certain tier, a contributor can open a pull request to adjust the scale for the integration.
|
||||
This request needs to be accompanied by the full checklist for each rule of scale (including all rules of lower tiers), demonstrating that it has met those requirements.
|
||||
The checklist can be found [here](checklist).
|
||||
The checklist can be found [here](/docs/core/integration-quality-scale/checklist).
|
||||
|
||||
Once the Home Assistant core team reviews and approves it, the integration will display the new tier as of the next major release of Home Assistant.
|
||||
|
||||
|
||||
@ -8,10 +8,11 @@ export default function RelatedRules({relatedRules}) {
|
||||
return (
|
||||
<ul>
|
||||
{relatedRules.map((rule) => {
|
||||
const absoluteRulePath = `/docs/core/integration-quality-scale/rules/${rule}`;
|
||||
const relatedRule = docs[`core/integration-quality-scale/rules/${rule}`].title;
|
||||
return (
|
||||
<li key={rule}>
|
||||
<Link to={rule}>{rule}</Link>: {relatedRule}
|
||||
<Link to={absoluteRulePath}>{rule}</Link>: {relatedRule}
|
||||
</li>
|
||||
);
|
||||
})}
|
||||
|
||||
@ -48,7 +48,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information on how to set up service actions, see the [service documentation](../../../dev_101_services).
|
||||
For more information on how to set up service actions, see the [service documentation](/docs/dev_101_services).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ class MySensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about polling can be found in the [documentation](../../../integration_fetching_data).
|
||||
More information about polling can be found in the [documentation](/docs/integration_fetching_data).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ This results not only in a more efficient system but the code is also more neat.
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information on how to create a library can be found in the [documentation](../../../api_lib_index).
|
||||
More information on how to create a library can be found in the [documentation](/docs/api_lib_index).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ This can be useful to clean up resources without having to keep track of the rem
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about config entries and their lifecycle can be found in the [config entry documentation](../../../config_entries_index).
|
||||
More information about config entries and their lifecycle can be found in the [config entry documentation](/docs/config_entries_index).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -60,8 +60,8 @@ async def test_full_flow(
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about config flows can be found in the [config flow documentation](../../../config_entries_config_flow_handler).
|
||||
More information about testing integrations can be found in the [testing documentation](../../../development_testing).
|
||||
More information about config flows can be found in the [config flow documentation](/docs/config_entries_config_flow_handler).
|
||||
More information about testing integrations can be found in the [testing documentation](/docs/development_testing).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -69,7 +69,7 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about config flows can be found in the [config flow documentation](../../../config_entries_config_flow_handler).
|
||||
More information about config flows can be found in the [config flow documentation](/docs/config_entries_config_flow_handler).
|
||||
More information about the architecture decision around config flows can be found in [ADR-0010](https://github.com/home-assistant/architecture/blob/master/adr/0010-integration-configuration.md)
|
||||
|
||||
## Exceptions
|
||||
|
||||
@ -45,7 +45,7 @@ If the device represents a service, be sure to add `entry_type=DeviceEntryType.S
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about devices can be found in the [device](../../../device_registry_index) documentation.
|
||||
More information about devices can be found in the [device](/docs/device_registry_index) documentation.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -58,8 +58,8 @@ This will create discovery flows for those devices.
|
||||
|
||||
## Additional resources
|
||||
|
||||
To learn more information about config flows, checkout the [config flow documentation](../../../config_entries_config_flow_handler).
|
||||
To learn more about network protocols and discovery, checkout the [Networking and discovery documentation](../../../network_discovery).
|
||||
To learn more information about config flows, checkout the [config flow documentation](/docs/config_entries_config_flow_handler).
|
||||
To learn more about network protocols and discovery, checkout the [Networking and discovery documentation](/docs/network_discovery).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -112,9 +112,9 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
|
||||
|
||||
## Additional resources
|
||||
|
||||
To learn more information about config flows, checkout the [config flow documentation](../../../config_entries_config_flow_handler).
|
||||
To learn more about discovery on network protocols, checkout the [Networking and discovery documentation](../../../network_discovery).
|
||||
To learn more about discovery for bluetooth devices, checkout the [Bluetooth documentation](../../../bluetooth).
|
||||
To learn more information about config flows, checkout the [config flow documentation](/docs/config_entries_config_flow_handler).
|
||||
To learn more about discovery on network protocols, checkout the [Networking and discovery documentation](/docs/network_discovery).
|
||||
To learn more about discovery for bluetooth devices, checkout the [Bluetooth documentation](/docs/bluetooth).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ class MySensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
To learn more about the registry properties, checkout the [documentation](../../entity#registry-properties) about it.
|
||||
To learn more about the registry properties, checkout the [documentation](/docs/core/entity#registry-properties) about it.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -42,8 +42,8 @@ class MyTemperatureSensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
A list of available device classes can be found in the entity pages under the [entity](../../entity) page.
|
||||
More information about entity naming can be found in the [entity](../../entity#has_entity_name-true-mandatory-for-new-integrations) documentation.
|
||||
A list of available device classes can be found in the entity pages under the [entity](/docs/core/entity) page.
|
||||
More information about entity naming can be found in the [entity](/docs/core/entity#has_entity_name-true-mandatory-for-new-integrations) documentation.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ class MySignalStrengthSensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
To learn more about the entity registry properties, checkout the [documentation](../../entity#registry-properties) about it.
|
||||
To learn more about the entity registry properties, checkout the [documentation](/docs/core/entity#registry-properties) about it.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -54,8 +54,8 @@ If the entity's platform is either `binary_sensor`, `number`, `sensor`, or `upda
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about the translation process can be found in the [translation](../../../internationalization/core) documentation, it also contains information about the [entity translations](../../../internationalization/core#name-of-entities).
|
||||
More information about entity naming can be found in the [entity](../../entity#has_entity_name-true-mandatory-for-new-integrations) documentation.
|
||||
More information about the translation process can be found in the [translation](/docs/internationalization/core) documentation, it also contains information about the [entity translations](/docs/internationalization/core#name-of-entities).
|
||||
More information about entity naming can be found in the [entity](/docs/core/entity#has_entity_name-true-mandatory-for-new-integrations) documentation.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -77,7 +77,7 @@ class MySensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information about managing integration state, see the [documentation](../../../integration_fetching_data).
|
||||
For more information about managing integration state, see the [documentation](/docs/integration_fetching_data).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ class MySensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about the requirements for a unique identifier can be found in the [documentation](../../../entity_registry_index#unique-id-requirements).
|
||||
More information about the requirements for a unique identifier can be found in the [documentation](/docs/entity_registry_index#unique-id-requirements).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ async def async_set_schedule(call: ServiceCall) -> ServiceResponse:
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more info on raising exceptions, check the [documentation](../../platform/raising_exceptions).
|
||||
For more info on raising exceptions, check the [documentation](/docs/core/platform/raising_exceptions).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -56,8 +56,8 @@ class MyLock(LockEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about entity naming can be found in the [entity](../../entity#has_entity_name-true-mandatory-for-new-integrations) documentation.
|
||||
More information about devices can be found in the [device](../../../device_registry_index) documentation.
|
||||
More information about entity naming can be found in the [entity](/docs/core/entity#has_entity_name-true-mandatory-for-new-integrations) documentation.
|
||||
More information about devices can be found in the [device](/docs/device_registry_index) documentation.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -53,7 +53,7 @@ class MySensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information about icon translations, check the [entity](../../entity#icon-translations) documentation.
|
||||
For more information about icon translations, check the [entity](/docs/core/entity#icon-translations) documentation.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -80,7 +80,7 @@ class MySensor(SensorEntity):
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information about managing integration state, see the [documentation](../../../integration_fetching_data)
|
||||
For more information about managing integration state, see the [documentation](/docs/integration_fetching_data)
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ This means that usually only the action calls will be relevant to consider for s
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information about request parallelism, check the [documentation](../../../integration_fetching_data#request-parallelism) for it.
|
||||
For more information about request parallelism, check the [documentation](/docs/integration_fetching_data#request-parallelism) for it.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -93,7 +93,7 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more info about handling expired credentials, check the [documentation](../../../integration_setup_failures#handling-expired-credentials).
|
||||
For more info about handling expired credentials, check the [documentation](/docs/integration_setup_failures#handling-expired-credentials).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -89,7 +89,7 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information on the reconfiguration flow, see the [reconfigure flow documentation](../../../config_entries_config_flow_handler#reconfigure).
|
||||
For more information on the reconfiguration flow, see the [reconfigure flow documentation](/docs/config_entries_config_flow_handler#reconfigure).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: MyConfigEntry) -> None:
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information about repair issues and repair flows, see the [repairs](../../platform/repairs) documentation.
|
||||
For more information about repair issues and repair flows, see the [repairs](/docs/core/platform/repairs) documentation.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: MyIntegrationConfigEntry
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about configuration entries and their lifecycle can be found in the [config entry documentation](../../../config_entries_index).
|
||||
More information about configuration entries and their lifecycle can be found in the [config entry documentation](/docs/config_entries_index).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -79,7 +79,7 @@ async def async_remove_config_entry_device(
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more info on devices, checkout the [device registry documentation](../../../device_registry_index).
|
||||
For more info on devices, checkout the [device registry documentation](/docs/device_registry_index).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about config flows can be found in the [config flow documentation](../../../config_entries_config_flow_handler).
|
||||
More information about config flows can be found in the [config flow documentation](/docs/config_entries_config_flow_handler).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ Please note that this may also be implemented implicitly when using a data updat
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about config entries and their lifecycle can be found in the [config entry documentation](../../../config_entries_index).
|
||||
More information about config entries and their lifecycle can be found in the [config entry documentation](/docs/config_entries_index).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ It also allows new developers to understand the codebase and make changes withou
|
||||
|
||||
## Additional resources
|
||||
|
||||
For more information about testing and how to calculate test coverage, see the [Testing your code](../../../development_testing) page.
|
||||
For more information about testing and how to calculate test coverage, see the [Testing your code](/docs/development_testing) page.
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
@ -106,8 +106,8 @@ If a configuration entry already exists for the same host, the flow will abort a
|
||||
|
||||
## Additional resources
|
||||
|
||||
More information about config flows can be found in the [config flow documentation](../../../config_entries_config_flow_handler).
|
||||
More information about the requirements for a unique identifier can be found in the [documentation](../../../entity_registry_index#unique-id-requirements).
|
||||
More information about config flows can be found in the [config flow documentation](/docs/config_entries_config_flow_handler).
|
||||
More information about the requirements for a unique identifier can be found in the [documentation](/docs/entity_registry_index#unique-id-requirements).
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user