Docker Hub README -> GitHub README?

[joshtrichards]

Maintaining the README on the Docker Hub entry has some challenges:

• ends up out of date (we update the GitHub README more often than we port over the changes to Docker Hub)
• some GitHub markdown conventions are not supported by Docker Hub (e.g. call-outs)
• it's more work for us

Questions:

• Is it okay for Docker Official Images to replace their Docker Hub contents (beyond the essentials like tags and some basic introductory context/etc) with a link to their GitHub README or other docs?
• If so, should we do this?
• Or, if we keep it, should we consider automating some of the updating?
• And, if we keep it, are the unsupported markdown bits worth keeping on GitHub?

[codecov[bot]]

Codecov Report

:x: Patch coverage is 16.00000% with 21 lines in your changes missing coverage. Please review. :white_check_mark: Project coverage is 14.84%. Comparing base (9a754e6) to head (d08a9ba). :warning: Report is 117 commits behind head on main.

Files with missing lines	Patch %	Lines
.../AppNavigation/EditCalendarModal/SharingSearch.vue	0.00%	15 Missing :warning:
...ents/AppNavigation/EditCalendarModal/ShareItem.vue	0.00%	5 Missing :warning:
src/store/calendars.js	0.00%	1 Missing :warning:

:exclamation: There is a different number of reports uploaded between BASE (9a754e6) and HEAD (d08a9ba). Click for more details.

HEAD has 4 uploads less than BASE

Flag	BASE (9a754e6)	HEAD (d08a9ba)
php	4	0

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #6998      +/-   ##
============================================
- Coverage     22.98%   14.84%   -8.14%     
============================================
  Files           254      212      -42     
  Lines         12589    10299    -2290     
  Branches       2478     2484       +6     
============================================
- Hits           2893     1529    -1364     
+ Misses         9346     8420     -926     
  Partials        350      350              

Flag	Coverage Δ
javascript	14.84% <16.00%> (+<0.01%)	:arrow_up:
php	?

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.