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

Added documentation for dapr dashboard #387

Merged
merged 2 commits into from
Jul 2, 2020

Conversation

gdhuper
Copy link
Member

@gdhuper gdhuper commented Jul 1, 2020

Description

Added docs for dapr dashboard command, and fixed a grammatical error.

Issue reference

This PR will close: #341

Checklist

  • Code compiles correctly
  • Extended the documentation

Copy link
Contributor

@shalabhms shalabhms left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution in writing doc for Dapr dashboard CLI command.

I have a few suggestions for pre-reqs.


## Description

Starts Dapr dashboard in a Kubernetes cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

dapr dashboard is for standalone and kubernetes. Only when invoked with flag -k , it starts for kubernetes.
So you might need to change "Start Dapr dashboard" for now. Since with current changes, it is not supported for standalone.

Copy link
Contributor

Choose a reason for hiding this comment

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

Since the dashboard deployment has to be done before running dashboard command.
It would be better to state that in the doc and command help about this pre-reqs:

Prerequisites : Dapr dashboard should be deployed in the Kubernetes cluster.
You can deploy the dashboard in the Kubernetes cluster as follows:
kubectl apply -f https://raw.githubusercontent.com/dapr/dashboard/master/deploy/dashboard.yaml "

Copy link
Member Author

Choose a reason for hiding this comment

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

Gotcha! I'll go ahead and update the docs. For dashboard deployment, I remember Yaron mentioning that dapr init would take care of it. Is that issue going to be tackled in this milestone?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes the plan is that dapr init will take care of, yes it is targeted to this milestone but might come later. Due to that, till it comes, it is better to add the prereqs in the doc, later it can be removed from doc once dapr init takes care of.

@gdhuper gdhuper requested a review from shalabhms July 2, 2020 01:53
Copy link
Contributor

@shalabhms shalabhms left a comment

Choose a reason for hiding this comment

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

/lgtm. Thanks

@shalabhms shalabhms merged commit 0da3c55 into dapr:master Jul 2, 2020
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.

New CLI command dashboard
2 participants