goharbor / goharbor/website

[documentation] Pushing images - formatting and less confusing explanation wanted

Open Beginner friendly
#758 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
46
Forks
222
PR merge metrics
No merged PRs in 30d

Description

Dear maintainers,

I think the ["Pushing images"](https://goharbor.io/docs/2.15.0/working-with-projects/working-with-images/pulling-pushing-images/#pushing-images) part of the documentation could benefit from some formatting and a little cleanup.

```
**Understanding the Image Name Structure**

In Harbor, a fully qualified image name has three main parts: /:. This is a critical concept for pushing images and configuring deployment tools.

Using the example /demo/ubuntu:14.04:
demo: This is the Project you created in the Harbor UI.
ubuntu: This is the Repository name inside the demo project. A repository holds all the tags for a single image.
14.04: This is the Tag, which usually represents a specific version of the image.

When configuring deployment tools (like Kubernetes or Kamal), ensure your target image name is set to the format /
```

1. I think both the example and the parts explained should be formatted as code using backticks. This way it would be more obvious even on first glance, what part of the explanation is the actual "snippet".

```
Using the example `/demo/ubuntu:14.04`:
`demo`: This is the Project you created in the Harbor UI.
`ubuntu`: This is the Repository name inside the demo project. A repository holds all the tags for a single image.
`14.04`: This is the Tag, which usually represents a specific version of the image.
```

2. Same goes for the part in the last sentence

```
When configuring deployment tools (like Kubernetes or Kamal), ensure your target image name is set to the format `/`
```

3. Better explain the full URL required in Kubernetes by using `` as in the example before, as just having the `` will create issues due to the runtime looking in e.g. Dockerhub or any other pre-defined registry shortcut, but not in Harbor...

```
When configuring deployment tools (like Kubernetes or Kamal), ensure your target image name is set to the format `//`
```

4. The last sentence is technically valid, but hard to read and grasp. I think there is a smoother way of explaining this, will try to come up with one...

Kind Regards,
Johannes

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked “Pushing images” section in the Harbor documentation and inspect how the example image name and its components are currently rendered. Done means the examples are visibly formatted as code, the Kubernetes image reference includes the Harbor address, and the final explanation is easier to understand when rendered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.