Skip to content
This repository has been archived by the owner on May 19, 2020. It is now read-only.

README should explain what Dashboard is & does #1271

Closed
yozlet opened this issue Oct 27, 2017 · 2 comments
Closed

README should explain what Dashboard is & does #1271

yozlet opened this issue Oct 27, 2017 · 2 comments

Comments

@yozlet
Copy link

yozlet commented Oct 27, 2017

I tell other CF users about our amazing Dashboard, and how they should try it and contribute. But, if I was one of those people, and I came here, I'd be pretty resistant. There's nothing in the README that explains or demonstrates the value. There's only a load of complex setup instructions. (There's a link to a testing server, but nothing about how to use it.)

We have the potential for many other CF-using orgs to both deploy and improve Dashboard, and the lack of good marketing material may be the kind of pebble on the tracks that derails most of those efforts before they get started.

Ideally, we'd have a separate brochure site/page that links to the repo, and have all this stuff there. But we can start with an early section of the README that includes:

  • The mission
  • A few screenshots of key screens that show sample data
  • A short list of views and operations that Dashboard makes available to users
  • Ditto, for admins
  • Positive qualities we've achieved
  • What it doesn't do, or why you might not want to use it
@brittag
Copy link
Contributor

brittag commented Oct 27, 2017

I like this idea! I wonder if we could do some of this work in a way that also directly serves cloud.gov's cost-recovery goals. We could make a page in our marketing content (a page somewhere in this section) that describes the cloud.gov dashboard as a feature of the product, including screenshots. That could help prospective customers understand the value of cloud.gov, and it could also help other CF deployments understand the dashboard as a feature they can reuse (if linked from this readme alongside additional information).

@yozlet
Copy link
Author

yozlet commented Oct 27, 2017

@brittag That'd be great! But can I suggest starting by hashing out rough material in the README, then moving it to the cloud.gov site when it's ready, rather than having this blocked by a publication approval dependency? (Unless the full process of adding material to cloud.gov is as easy as adding to the README, in which case ignore me)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants