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

Updated install docs with guidance about testing minikube #574

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

m3dwards
Copy link
Collaborator

@m3dwards m3dwards commented Sep 10, 2024

I think these docs are clearer on what you have to do. I also got rid of the quickstart document as it's duplicated in the install.md doc.

Fixes: #570

@bdp-DrahtBot
Copy link
Collaborator

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #531 (unified HTML landing page (NOT a dashboard!) by willcl-ark)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@josibake
Copy link
Collaborator

LGTM, much cleaner! Prompting people to go to docker desktop / minikube docs is excellent. I recently suggested we might need a CONTRIBUTING.md doc in the top level of the repo, which would conflict with your naming here. Perhaps we can call this dependencies.md / installing.md ?

@josibake
Copy link
Collaborator

(can also merge now and change the name later if / when we do add a contributing.md)

@josibake josibake merged commit b1a3fcf into main Sep 11, 2024
14 checks passed
@m3dwards
Copy link
Collaborator Author

I recently suggested we might need a CONTRIBUTING.md doc in the top level of the repo

I'll just move / rename it, probably would need to be filled out a bit more later too.

@m3dwards m3dwards deleted the doc/test-k8s branch September 11, 2024 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: On the dependencies for install write a section that proves that minikube is running
3 participants