Skip to content

Commit

Permalink
docs: remove docker compose top-level element 'version' (#2035)
Browse files Browse the repository at this point in the history
Docker compose 'version' element has been deprecated and shows up with an obsoleted error.

On the install from Package guide, remove docker compose top-level element 'version'

Following the document https://github.com/compose-spec/compose-spec/blob/master/spec.md#version-top-level-element , The top-level version property is defined by the Compose Specification for backward compatibility. It is only informative.

As a result, On the install from Package documents need to remove deprecated top-level version element.

Fixed #2034

<!--
Please precisely, concisely, and concretely describe what this PR changes, the rationale behind codes,
and how it affects the users and other developers.
-->

**Checklist:** (if applicable)

- [ ] Milestone metadata specifying the target backport version
- [ ] Mention to the original issue
- [ ] Installer updates including:
  - Fixtures for db schema changes
  - New mandatory config options
- [ ] Update of end-to-end CLI integration tests in `ai.backend.test`
- [ ] API server-client counterparts (e.g., manager API -> client SDK)
- [ ] Test case(s) to:
  - Demonstrate the difference of before/after
  - Demonstrate the flow of abstract/conceptual models with a concrete implementation
- [ v ] Documentation
  - Contents in the `docs` directory
  - docstrings in public interfaces and type annotations

<!-- readthedocs-preview sorna start -->
----
📚 Documentation preview 📚: https://sorna--2035.org.readthedocs.build/en/2035/

<!-- readthedocs-preview sorna end -->

<!-- readthedocs-preview sorna-ko start -->
----
📚 Documentation preview 📚: https://sorna-ko--2035.org.readthedocs.build/ko/2035/

<!-- readthedocs-preview sorna-ko end -->
  • Loading branch information
studioego committed Apr 25, 2024
1 parent 28bb60c commit edef020
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 3 deletions.
1 change: 1 addition & 0 deletions changes/2035.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove deprecated `version` from the docker compose YAML templates in package installation docs.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ refer

.. code-block:: yaml
version: "3"
x-base: &base
logging:
driver: "json-file"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ refer

.. code-block:: yaml
version: "3"
x-base: &base
logging:
driver: "json-file"
Expand Down
1 change: 0 additions & 1 deletion docs/install/install-from-package/prepare-database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ refer

.. code-block:: yaml
version: "3"
x-base: &base
logging:
driver: "json-file"
Expand Down

0 comments on commit edef020

Please sign in to comment.