Skip to content
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.

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

[YUNIKORN-1299] kind docs #214

Closed
wants to merge 1 commit into from
Closed

Conversation

kannon92
Copy link
Contributor

@kannon92 kannon92 commented Nov 21, 2022

This ticket addresses the following items in 1299:

  • Should add kind as a deployment option to the "Deploy to Kubernetes" page. Pointer can be added to the validate_cluster script as an example.
  • reference to "some published docker images under this docker hub repo", images are part of the release not just random images anymore
  • broken link under dependencies
    as explained in the [Update dependencies](#Updating dependencies).
  • the web UI image can be build using the two stage docker not requiring any installs, should only point back to the repo readme for dev setup

@kannon92
Copy link
Contributor Author

I'm unclear what this link is supposed to be for:

During the creation of a release, tags will be created.
These tags will be used as the reference in the go.mod files for the release.

Could use some advice on what to change here?

@kannon92
Copy link
Contributor Author

I believe the docker image locations are correct and they say:

Currently, there are some published docker images under this docker hub repo, you are free to fetch and use.

What change do you want here?

docs/developer_guide/build.md Show resolved Hide resolved
docs/developer_guide/dependencies.md Outdated Show resolved Hide resolved
docs/developer_guide/env_setup.md Show resolved Hide resolved
docs/developer_guide/env_setup.md Outdated Show resolved Hide resolved
docs/developer_guide/env_setup.md Show resolved Hide resolved
@wilfred-s
Copy link
Contributor

Could use some advice on what to change here?

The link is correct https://yunikorn.apache.org/community/release_procedure#tag-and-update-release-for-version
The tagging is a standard git tag action don't think we need to update that

@wilfred-s
Copy link
Contributor

I believe the docker image locations are correct and they say:

Currently, there are some published docker images under this docker hub repo, you are free to fetch and use.

What change do you want here?

Under this heading we mention the text:
Currently, there are some published docker images under this docker hub repo, you are free to fetch and use.
That should be changed to something more like:
If you want to use pre-build images based on a release please check the docker hub repo....

The other broken link is part of this heading here it renders in a broken way:

Changing dependencies uses mod replace directives as explained in the [Update dependencies](#Updating dependencies).

That last text should be rendered as a link and point to this heading

@kannon92 kannon92 changed the title WIP: YUNIKORN-1299 kind docs YUNIKORN-1299 kind docs Nov 25, 2022
@wilfred-s
Copy link
Contributor

One point outstanding around the kind version and K8s version. Rest looks good now.

Copy link
Contributor

@craigcondit craigcondit left a comment

Choose a reason for hiding this comment

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

+1, will commit shortly.

@craigcondit craigcondit changed the title YUNIKORN-1299 kind docs [YUNIKORN-1299] kind docs Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants