Skip to content

docs: require explicit docker image versions - #1577

Open
DeepDiver1975 wants to merge 2 commits into
10.15from
docs/explicit-image-version-10.15
Open

docs: require explicit docker image versions#1577
DeepDiver1975 wants to merge 2 commits into
10.15from
docs/explicit-image-version-10.15

Conversation

@DeepDiver1975

Copy link
Copy Markdown
Member

Every documented docker image reference on this branch now carries an explicit
version tag, and latest is no longer presented as a valid option. Same change
as #1576 (10.16) and #1575 (master).

owncloud/server:latest does not track the release line documented here — it
follows whatever the newest published image happens to be — so a reader copying
the examples, or a container restart, can end up on a different version than the
documentation describes. There are also no rolling major or minor tags
(owncloud/server:10.15 and :10 both 404 on Docker Hub), so a full version is
the only correct thing to name.

Changes

modules/admin_manual/pages/installation/docker/index.adoc

  • Adds a docker-image-version page attribute set to the literal 10.15.3, the
    top of this release line. This intentionally does not reuse
    {latest-server-version}: that is a global site attribute tracking the latest
    release of the product, and the value that wins is the aggregator's
    (owncloud/docs global-attributes.yml), not this branch's antora.yml — which
    is why the published page currently renders OWNCLOUD_VERSION=10.16 here.
  • Tags the quick-evaluation docker run (owncloud/server:10.15.3); it was
    untagged, which resolves to latest.
  • OWNCLOUD_VERSION in the .env example now names the explicit version, and the
    required-settings table no longer gives latest as its example value.
  • Adds a note explaining why OWNCLOUD_VERSION must be pinned.

modules/developer_manual/pages/testing/ui-testing.adoc

  • Pins the two untagged selenium/standalone-firefox* pulls, the untagged
    selenium/standalone-chrome-debug run, and both inbucket/inbucket
    references. The selenium pins use 3.141.59-oxygen, matching the chrome pins
    the page already carries because of the issue it links (webUI tests do not run with latest docker-selenium 3.141.59-palladium core#35444);
    inbucket uses 3.1.1, its newest release tag. All five tags verified present
    on Docker Hub.

Testing

npm run antora-local (Node 22, as pinned by this branch's ci.yml) builds with
no errors and no warnings. The rendered page shows OWNCLOUD_VERSION=10.15.3,
owncloud/server:10.15.3, and no occurrence of latest in the settings table;
all five image pins render on the UI testing page.

Note on timing

10.15 is about to be dropped from the published site and archived as
x_archived_10.15, so this content will not be published for long. It is worth
merging anyway: it keeps the branch correct for the window before the
owncloud/docs change lands, and should the branch ever be un-archived it is not
left documenting an image tag that points somewhere else. This PR needs to merge
before the branch is renamed.

Every documented image reference now carries an explicit version tag and
the `latest` tag is no longer offered as an option. `owncloud/server:latest`
does not necessarily point to the release line documented on this branch,
so a container restart can silently pull a different version.

The docker page uses a literal `docker-image-version` page attribute rather
than one of the global `-version` attributes: those track the latest release
of the product, which is not this branch, so interpolating them here would
document an image that does not belong to this release line.

Also pin the selenium and inbucket images in the UI testing guide, matching
the chrome pins the page already carries for owncloud/core#35444.

Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
phil-davis
phil-davis previously approved these changes Jul 30, 2026
The page deliberately links into the *latest* server version rather than this
branch, but it used this branch's page paths. The 11.0 release is docker-only
and reorganized accordingly: `installation/index.adoc` (manual installation) is
gone, the docker page moved from `installation/docker/index.adoc` to
`installation/installing_with_docker.adoc`, and `maintenance/manual_upgrade.adoc`
moved under `maintenance/upgrading/`.

Three of the five links therefore break as soon as `latest-server-version`
advances to 11.0, which fails the aggregated site build. Point them at the paths
that exist there and drop the manual installation entry, which has no 11.0
equivalent.

Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
@DeepDiver1975

Copy link
Copy Markdown
Member Author

Added a second commit that fixes useful_pages.adoc, matching #1576.

That page deliberately xrefs into the latest server version rather than this branch, but used this branch's page paths. 11.0 is a docker-only release and reorganized accordingly, so three of the five links break once latest-server-version advances: installation/index.adoc no longer exists, the docker page moved to installation/installing_with_docker.adoc, and maintenance/manual_upgrade.adoc moved under maintenance/upgrading/.

Unlike on 10.16 this cannot fail the site build, since this branch is being dropped from the published site — but it is the same belt-and-braces reasoning as the :latest fix: keep the branch content correct in case it is ever un-archived.

npm run antora-local on this branch: 0 errors, 0 warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants