docs: remove links to no-longer-used stability tiers #101
Conversation
|
Relates to equinix-labs/equinix-labs#107 |
README.md
Outdated
|
|
||
| [](https://github.com/equinix-labs/equinix-labs/blob/main/uniform-standards.md) | ||
|
|
||
| > **[Experimental](https://github.com/equinix-labs/equinix-labs/blob/main/experimental-statement.md)** | ||
| > This is experimental. Don't use it in production. Examples demonstrate that this client is usable. Please submit patches and open issues with your experience. This repo contains Python code generated from a customized [metal_openapi.fixed.yaml](metal_openapi.fixed.yaml) based on the [Equinix Metal API spec](https://api.equinix.com/metal/v1/api-docs). The client is generated using the python-nextgen generator built into the [OpenAPITools openapi-generator](https://github.com/OpenAPITools/openapi-generator). |
There was a problem hiding this comment.
This warning was added to the project ahead of the 0.1.0 release in March 2023 (#22). We've since solidified the maintenance and usage patterns through CI actions and example projects. This project is in use by the Ansible collection which does not provide the same warning.
While we are removing the Experimental labels, we can remove the disclaimer and advise on this line. We are removing the labels because the projects are offered as-is, per the license file. Use at your own risk is part of that license.
Removal of the Experimental warnings does not explicitly endorse the project's production readiness or imply a long-term commitment to it. In fact, we have been considering the need for an equinix-sdk-python project to consolidate Metal, Fabric, and other Equinix API Python SDK needs.
| > This is experimental. Don't use it in production. Examples demonstrate that this client is usable. Please submit patches and open issues with your experience. This repo contains Python code generated from a customized [metal_openapi.fixed.yaml](metal_openapi.fixed.yaml) based on the [Equinix Metal API spec](https://api.equinix.com/metal/v1/api-docs). The client is generated using the python-nextgen generator built into the [OpenAPITools openapi-generator](https://github.com/OpenAPITools/openapi-generator). | |
| > Examples demonstrate that this client is usable. Please submit patches and open issues with your experience. This repo contains Python code generated from a customized [metal_openapi.fixed.yaml](metal_openapi.fixed.yaml) based on the [Equinix Metal API spec](https://api.equinix.com/metal/v1/api-docs). The client is generated using the python-nextgen generator built into the [OpenAPITools openapi-generator](https://github.com/OpenAPITools/openapi-generator). |
|
This PR is included in version 0.11.0 🎉 |
This removes links to the old stability tier documents that used to be in equinix-labs/equinix-labs. Those tiers did not reflect reality and we are discontinuing their use. The experimental nature of this repo does not change as a result of this documentation change; we are simply removing references to the old documentation.