Add troubleshooting for an absent image to README #50357
Conversation
Signed-off-by: Dmitry Shurupov <dmitry.shurupov@palark.com>
shurup
added
sig/docs
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/XS
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
| ### Unable to find image 'gcr.io/k8s-staging-sig-docs/k8s-website-hugo:VERSION' locally | ||
|
|
||
| If you run `make container-serve` and see this error, it might be due to the local changes made to specific files [defined](https://github.com/kubernetes/website/blob/main/Makefile#L10) in the `$IMAGE_VERSION` of `Makefile`. | ||
|
|
||
| The website image versioning includes a hash, which is generated based on the content of the listed files. E.g., if `1b9242684415` is the hash for these files, the website image will be called `k8s-website-hugo:v0.133.0-1b9242684415`. Executing `make container-serve` will try to pull such an image from the Kubernetes website’s GCR. If it’s not a current version, you’ll see an error saying this image is absent. | ||
|
|
||
| If you need to make changes in these files and preview the website, you’ll have to build your local image instead of pulling a pre-built one. To do so, proceed with running `make container-image`. |
There was a problem hiding this comment.
It's good for a README to be short. Ideally, even shorter than it is now.
I recommend we hyperlink to a page within https://kubernetes.io/docs/contribute/ and assume that people working on docs have web access. What do folks think?
There was a problem hiding this comment.
Good point! As I can see, the /docs/contribute/ section currently lacks details on running the website locally. IMHO, it would be reasonable to create a separate page moving there all the details from README on how to run the website (and all related troubleshooting). I think I can do it if everyone agrees.
This PR follows our recent discussion with @SayakMukhopadhyay regarding my issue with an absent website image due to the changes made to
package-lock.json. It adds an explanation for such cases to the Troubleshooting section of README.I have some related questions, though:
make container-servepulls a remote image, but sometimes, it might not work for various reasons… If so, I can do it but I think it should be a part of Running the website using a container, not just Troubleshooting.