Skip to content

Add troubleshooting for an absent image to README #50357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add troubleshooting for an absent image to README #50357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,14 @@ sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist

This works for Catalina as well as Mojave macOS.

### 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`.
Comment on lines +163 to +169
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well we do have https://kubernetes.io/docs/contribute/new-content/open-a-pr/#preview-locally

How about extracting that section into its own dedicated page?


## Get involved with SIG Docs

Learn more about SIG Docs Kubernetes community and meetings on the [community page](https://github.com/kubernetes/community/tree/master/sig-docs#meetings).
Expand Down