Re: Clean up project names / descriptions?


Dan Kohn <dan@...>
 

On Tue, Aug 21, 2018 at 4:42 PM, Geri Jennings <geri.jennings@...> wrote:
Hello all,

I downloaded a CSV of the full landscape this afternoon, and the naming and descriptions are pretty inconsistent. Ideally the "name" field would give the product name and the description field would describe that product, but it's often the case that the description has very little information or describes the company instead of the product.

The description for open source projects comes from the GitHub description field. For closed source products, the description is submitted in the landscape.yml. 
 
It's probably unreasonable at this point to expect the companies that submitted the original PRs to come back and edit their listings, but it would be great if the list were cleaner for people coming to see the list for the first time. Should I take a crack at rewriting some of it? Is it appropriate for someone not from the company that submitted it to edit a company's listing?

In either case, I would recommend against making a change without getting buy-in from the product/project owner. I don't think most companies would be happy with you adding a product description without their agreement.
 
In addition, I downloaded the CSV because there wasn't a way on landscape.cncf.io to see the descriptions in the web UI view. I would like to suggest we consider adding a "list" view as an option besides the "card" view that would show more information to people who are browsing the landscape.

The descriptions show in the modal card view, just above the website. For example, Prometheus <https://landscape.cncf.io/selected=prometheus> says "The Prometheus monitoring system and time series database."

We could add a list view, but I don't think it would add a lot of value compared to the CSV mode, which downloads all data for the view you have currently selected.
--
Dan Kohn <dan@...>
Executive Director, Cloud Native Computing Foundation https://www.cncf.io
+1-415-233-1000 https://www.dankohn.com

 

Join cncf-reference-architecture@lists.cncf.io to automatically receive all group messages.