Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove docker compose top-level element 'version' #2035

Merged
merged 1 commit into from Apr 25, 2024

Conversation

studioego
Copy link
Contributor

@studioego studioego commented Apr 18, 2024

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

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

馃摎 Documentation preview 馃摎: https://sorna--2035.org.readthedocs.build/en/2035/


馃摎 Documentation preview 馃摎: https://sorna-ko--2035.org.readthedocs.build/ko/2035/

@studioego studioego added the area:docs Documentations label Apr 18, 2024
@studioego studioego requested a review from adrysn April 18, 2024 15:29
@studioego studioego self-assigned this Apr 18, 2024
@github-actions github-actions bot added type:feature Add new features size:XS ~10 LoC labels Apr 18, 2024
changes/2035.doc.md Outdated Show resolved Hide resolved
Copy link
Member

@adrysn adrysn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the change logs. Other updates are looks good to me.

@studioego studioego requested a review from adrysn April 25, 2024 05:54
changes/2035.doc.md Outdated Show resolved Hide resolved
@studioego studioego requested a review from adrysn April 25, 2024 06:44
Copy link

graphite-app bot commented Apr 25, 2024

Merge activity

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 -->
@adrysn adrysn force-pushed the docs/docker-compose-version-element-obsolete branch from 3e97190 to edef020 Compare April 25, 2024 06:57
@graphite-app graphite-app bot merged commit edef020 into main Apr 25, 2024
26 checks passed
@graphite-app graphite-app bot deleted the docs/docker-compose-version-element-obsolete branch April 25, 2024 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Documentations size:XS ~10 LoC type:feature Add new features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docker compose 'version' element has been deprecated and shows up with an obsoleted error
2 participants