docs: deprecate daemon's api-cors-header flag

docker / cli

The Docker CLI

Apache License 2.0

4.88k stars 1.92k forks source link

docs: deprecate daemon's api-cors-header flag #5085

Closed akerouanton closed 4 months ago

akerouanton commented 4 months ago

Related to:

https://github.com/moby/moby/pull/45313

- What I did

Update the "Deprecated Engine Features" doc page to warn about daemon's api-cors-header deprecation.

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 61.31%. Comparing base (57a1180) to head (9d9bb19). Report is 16 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #5085 +/- ## ========================================== - Coverage 61.32% 61.31% -0.01% ========================================== Files 298 295 -3 Lines 20706 20701 -5 ========================================== - Hits 12698 12693 -5 + Misses 7106 7105 -1 - Partials 902 903 +1 ```

thaJeztah commented 4 months ago

I'll bring this one in; one more thing we may need to consider is to add some notes on https://github.com/docker/cli/blob/6a4d38c7f2fe17351f78ff9dfe7ec2ee9b15f1df/docs/reference/dockerd.md

The dockerd docs are not (yet) generated from Cobra, so that means we won't have a table with options / annotations that flags are deprecated. And we also have the option documented for the daemon.json config.

@dvdksn if you have any good ideas how to update those docs; let me know. I don't expect it to be a popular option, but .. well .. someone, somewhere will likely use it.