Update documentation as using Github Packages registry instead of Dockerhub #931
Conversation
thachlp
requested review from
ikhoon,
jrhee17,
minwoox and
trustin
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #931 +/- ##
============================================
+ Coverage 66.78% 66.80% +0.02%
- Complexity 3513 3516 +3
============================================
Files 370 370
Lines 14476 14476
Branches 1553 1553
============================================
+ Hits 9668 9671 +3
+ Misses 3929 3928 -1
+ Partials 879 877 -2 ☔ View full report in Codecov by Sentry. |
Thanks @Dogacel |
| Using Docker? Launch our image at `Github Packages registry <https://github.com/line/centraldogma/pkgs/container/centraldogma>`_: | ||
|
|
||
| .. code-block:: shell | ||
|
|
||
| $ docker run -p 36462:36462 line/centraldogma | ||
| $ docker run -p 36462:36462 ghcr.io/line/centraldogma |
| final String localRepoStatus = localRepo == null ? "not specified" : "does not exist"; | ||
| logger.warn("Mirroring is not possible because one or more conditions are not met: " + | ||
| "mirroring enabled={}, localRepo={}, localRepo status={}. " + | ||
| "Please ensure mirroring is enabled, a local repository name is specified, " + | ||
| "and the local repository exists.", | ||
| enabled, localRepo == null ? "null" : localRepo, localRepoStatus); |
There was a problem hiding this comment.
It should be noisy to warn for a disabled mirror. How about leaving the warning for the enabled mirror configurations?
There was a problem hiding this comment.
Let's completely remove this warning. This log is only present in the server, so users wouldn't see this warning log anyway. I believe we need to address this in #838
There was a problem hiding this comment.
From a user perspective, I don't know I need to create localRepo, so If after set up by docs and it didn't work, I can check the log and fix. Is it necessary?
There was a problem hiding this comment.
I understand the challenges you've faced. However, this warning doesn't provide any useful information because the user setting up the mirror cannot see the log.
For instance, if you're trying to set up mirroring to the Central Dogma instance that I'm operating, even with incorrect configuration, you wouldn't see the warning because you don't have access to the logs. Adding these logs would only clutter the server logs, which is the current situation on the instances I'm operating.
Therefore, we're preparing another method to alert users if the configuration is incorrect. You can find it here: #838
There was a problem hiding this comment.
@minwoox understand, thanks for explaining to me
There was a problem hiding this comment.
I updated the pr title and description🙇
thachlp
changed the title
thachlp
changed the title
|
@thachlp 👍 👍 👍 |
Motivation
We must also update the document since centraldogma used Github Packages registry.
Related: #926