mirror of https://github.com/astral-sh/uv
Add policies reference section and license document (#9367)
In preparation for adding more pages to the reference section e.g., <img width="1427" alt="Screenshot 2024-11-27 at 1 19 10 PM" src="https://github.com/user-attachments/assets/10079959-ee01-4c3f-b38e-7c2a7022dd9d">
This commit is contained in:
parent
9262d44f1d
commit
6cb3bf2b13
|
|
@ -417,6 +417,6 @@ update was backwards-compatible. However, this is not guaranteed, and uv may exi
|
|||
it encounters a lockfile with an outdated schema version.
|
||||
|
||||
The schema version is considered part of the public API, and so is only bumped in minor releases, as
|
||||
a breaking change (see [Versioning](../reference/versioning.md)). As such, all uv patch versions
|
||||
within a given minor uv release are guaranteed to have full lockfile compatibility. In other words,
|
||||
lockfiles may only be rejected across minor releases.
|
||||
a breaking change (see [Versioning](../reference/policies/versioning.md)). As such, all uv patch
|
||||
versions within a given minor uv release are guaranteed to have full lockfile compatibility. In
|
||||
other words, lockfiles may only be rejected across minor releases.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,6 @@ The reference section provides information about specific parts of uv:
|
|||
- [Commands](./cli.md): A reference for uv's command line interface.
|
||||
- [Settings](./settings.md): A reference for uv's configuration schema.
|
||||
- [Resolver](./resolver-internals.md): Details about the internals of uv's resolver.
|
||||
- [Versioning](./versioning.md): uv's versioning policy.
|
||||
- [Platform support](./platforms.md): uv's supported operating systems and architectures.
|
||||
- [Policies](./policies/index.md): uv's versioning policy, platform support policy, and license.
|
||||
|
||||
Looking for a broader overview? Check out the [concepts](../concepts/index.md) documentation.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
# Policies
|
||||
|
||||
- [Versioning](./versioning.md)
|
||||
- [Platform support](./platforms.md)
|
||||
- [License](./license.md)
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# License
|
||||
|
||||
uv is licensed under either of
|
||||
|
||||
- Apache License, Version 2.0
|
||||
|
||||
[LICENSE-APACHE](https://github.com/astral-sh/uv/blob/main/LICENSE-APACHE) or
|
||||
<https://www.apache.org/licenses/LICENSE-2.0>
|
||||
|
||||
- MIT License
|
||||
|
||||
[LICENSE-MIT](https://github.com/astral-sh/uv/blob/main/LICENSE-MIT) or
|
||||
<https://opensource.org/licenses/MIT>
|
||||
|
||||
at your option.
|
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in uv
|
||||
by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any
|
||||
additional terms or conditions.
|
||||
|
|
@ -11,10 +11,10 @@ uv's changelog can be [viewed on GitHub](https://github.com/astral-sh/uv/blob/ma
|
|||
## Cache versioning
|
||||
|
||||
Cache versions are considered internal to uv, and so may be changed in a minor or patch release. See
|
||||
[Cache versioning](../concepts/cache.md#cache-versioning) for more.
|
||||
[Cache versioning](../../concepts/cache.md#cache-versioning) for more.
|
||||
|
||||
## Lockfile versioning
|
||||
|
||||
The `uv.lock` schema version is considered part of the public API, and so will only be incremented
|
||||
in a minor release as a breaking change. See
|
||||
[Lockfile versioning](../concepts/resolution.md#lockfile-versioning) for more.
|
||||
[Lockfile versioning](../../concepts/resolution.md#lockfile-versioning) for more.
|
||||
|
|
@ -68,6 +68,8 @@ plugins:
|
|||
redirect_maps:
|
||||
"concepts/workspaces.md": "concepts/projects/workspaces.md"
|
||||
"concepts/dependencies.md": "concepts/projects/dependencies.md"
|
||||
"reference/versioning.md": "reference/policies/versioning.md"
|
||||
"reference/platforms.md": "reference/policies/platforms.md"
|
||||
extra_css:
|
||||
- stylesheets/extra.css
|
||||
extra_javascript:
|
||||
|
|
@ -148,8 +150,11 @@ nav:
|
|||
- Build failures: reference/build_failures.md
|
||||
- Resolver: reference/resolver-internals.md
|
||||
- Benchmarks: reference/benchmarks.md
|
||||
- Versioning: reference/versioning.md
|
||||
- Platform support: reference/platforms.md
|
||||
- Policies:
|
||||
- reference/policies/index.md
|
||||
- Versioning: reference/policies/versioning.md
|
||||
- Platform support: reference/policies/platforms.md
|
||||
- License: reference/policies/license.md
|
||||
validation:
|
||||
omitted_files: warn
|
||||
absolute_links: warn
|
||||
|
|
|
|||
Loading…
Reference in New Issue