docs: create INTHEWILD.md #10212
docs: create INTHEWILD.md #10212
Conversation
Create INTHEWILD.md to: 1. collect all Superset users into a single document and shorten README to make it more usable; 2. Categorize users into broad industry categories, which makes the document more useful as a reference for new users looking for industry peers and best practices (e.g. healthcare industry has unique needs and use cases); 3. removed some companies, whose website is inaccessible or defunct.
Codecov Report
@@ Coverage Diff @@
## master #10212 +/- ##
==========================================
- Coverage 70.45% 65.42% -5.04%
==========================================
Files 594 598 +4
Lines 31498 32011 +513
Branches 3223 3239 +16
==========================================
- Hits 22193 20944 -1249
- Misses 9198 10886 +1688
- Partials 107 181 +74
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
can you abc order the companies in each category?
Also, you'll need to add the apache license in the same fashion as README.md.
Finally, could you include removing the list from the README in the same PR as making INTHEWILD.md? That way we don't accidentally miss a company when moving stuff over.
INTHEWILD.md
Outdated
|
|
||
| Here's a list of organizations, broken down into broad industry categories, that have taken the time to send a PR to let | ||
| the world know they are using Apache Superset. If you are a user and want to be recognized, | ||
| all you have to do is file a simple PR [like this one](https://github.com/apache/incubator-superset/pull/7576). If you think |
There was a problem hiding this comment.
This pr is probably out of date now, maybe we should remove it?
There was a problem hiding this comment.
Or replace it with another PR that adds a company to this file, once this has been merged in
There was a problem hiding this comment.
Updated the PR example to a recent one
There was a problem hiding this comment.
We probably should just remove this link altogether, then add one back in once someone has edited this file post merge
|
Personally I prefer having the list in the |
|
I think it's fair to say the README is too large right now (github.com/apache/incubator-superset takes up 11 screen heights for me) and we should try and optimize for only showing the most important content there. If the marketing that our user list provides is the most important part of having this in the README, I'd recommend something like a curated row of the logos of the most influential users in the README, with a link to INTHEWILD below. Superset's large userbase is evident by the repo's star count, and highlighting major users with logos in the README would both take up less space and increase the signal to noise ratio (for example I care more that Lyft uses Superset than a smaller startup). Thoughts @mistercrunch? |
|
Totally fair @etr2460 . I was more concerned about people not discovering that they may want to add themselves to the list. I think that self-reported endorsement are strong statements that are nice to accumulate and surface, but I agree that This PR should probably also remove entries from |
|
Thank you for all the comments. So do we have agreement that we should have INTHEWILD as it is currently organized in a separate doc to link out from README? If so, I'll make the necessary changes in README, i.e. remove current list, add link from top nav section, etc. |
|
I think we do not want the same info in 2 places. Maybe the README would have key (most recognizable) logos and a link to INTHEWILD ## In the Wild
dozens of [logos]
see the full list and let the world know you use Superset [here](INTHEWILD.md) |
|
Yeah, I think that's what @ceohockey60 was recommending |
|
Made all the changes in both INTHEWILD and README. PTAL. Thanks @etr2460. |
INTHEWILD.md
Outdated
| ## License | ||
|
|
||
| ``` | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| ``` |
There was a problem hiding this comment.
you probably don't need the license here if it's in the comment above.
There was a problem hiding this comment.
cool removed.
@suddjian please review when you have a sec. thank you!
* Create INTHEWILD.md Create INTHEWILD.md to: 1. collect all Superset users into a single document and shorten README to make it more usable; 2. Categorize users into broad industry categories, which makes the document more useful as a reference for new users looking for industry peers and best practices (e.g. healthcare industry has unique needs and use cases); 3. removed some companies, whose website is inaccessible or defunct. * Update INTHEWILD.md * Update INTHEWILD.md * Update README.md * Update INTHEWILD.md * Update INTHEWILD.md * Update README.md
mistercrunch
added
🏷️ bot
SUMMARY
Create INTHEWILD.md to:
After this file is created, will link to it from README.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TEST PLAN
ADDITIONAL INFORMATION