docs: Update and refresh homepage of superset.apache.org #10477
Conversation
Update and refresh index with additional links to community resources, new links to `Databases' section directly to parts of the tutorial that talk about that database, connect, align Superset topline features with same language as in GitHub
ceohockey60
changed the title
Codecov Report
@@ Coverage Diff @@
## master #10477 +/- ##
==========================================
+ Coverage 70.78% 70.83% +0.05%
==========================================
Files 604 605 +1
Lines 32385 32431 +46
Branches 3281 3423 +142
==========================================
+ Hits 22924 22974 +50
+ Misses 9349 9345 -4
Partials 112 112
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
docs/index.rst
Outdated
|
|
||
| Databases | ||
| --------- | ||
|
|
||
| The following RDBMS are currently supported: | ||
|
|
||
| - `Amazon Athena <https://aws.amazon.com/athena/>`_ | ||
| - `Amazon Athena <https://superset.incubator.apache.org/installation.html#aws-athena>`_ |
There was a problem hiding this comment.
if this is linking to a page in the docs, do we need the full url? I'd guess /installation.html#aws-athena would be sufficient
There was a problem hiding this comment.
I just tried and it doesn't work, probably because it's .rst so the whole site is generated differently and doesn't work the same way? (I'm no .rst expert...)
There was a problem hiding this comment.
I validated that the following change works for me when building the html and running locally, I think this should be safe to do:
diff --git a/docs/index.rst b/docs/index.rst
index c1af917c1..42d9c28a2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -99,7 +99,7 @@ Databases
The following RDBMS are currently supported:
-- `Amazon Athena <https://superset.incubator.apache.org/installation.html#aws-athena>`_
+- `Amazon Athena </installation.html#aws-athena>`_
- `Amazon Redshift <https://aws.amazon.com/redshift/>`_
- `Apache Drill <https://superset.incubator.apache.org/installation.html#apache-drill>`_
- `Apache Druid <https://superset.incubator.apache.org/installation.html#druid>`_There was a problem hiding this comment.
Awesome, thanks for validating. Updated all the links accordingly.
| - `Vertica <https://www.vertica.com/>`_ | ||
| - `Hana <https://www.sap.com/products/hana.html>`_ | ||
| - `Amazon Athena </installation.html#aws-athena>`_ | ||
| - `Amazon Redshift </installation.html#database-dependencies>`_ |
There was a problem hiding this comment.
What's the value in linking to the generic page here instead of the more specific db website?
There was a problem hiding this comment.
The "database dependencies" table has some information re installation for all the db options, but some db options have their own dedicated anchor tag (I'm not sure why the docs are written this way...). For the ones that have their own tag, it's link to there, but ones that don't, the link points to the "database dependencies" table for community users, which is more helpful than the homepage of the db itself with useful info as it relates to Superset.
Add link to docs repo on the homepage to encourage easy access for community contribution.
* Update and refresh Index Update and refresh index with additional links to community resources, new links to `Databases' section directly to parts of the tutorial that talk about that database, connect, align Superset topline features with same language as in GitHub * Added link to Superset users * Update with relative links * Add link to docs repo Add link to docs repo on the homepage to encourage easy access for community contribution. * Update index.rst
* Update and refresh Index Update and refresh index with additional links to community resources, new links to `Databases' section directly to parts of the tutorial that talk about that database, connect, align Superset topline features with same language as in GitHub * Added link to Superset users * Update with relative links * Add link to docs repo Add link to docs repo on the homepage to encourage easy access for community contribution. * Update index.rst
mistercrunch
added
🏷️ bot
Update and refresh index with additional links to community resources, new links to `Databases' section directly to parts of the tutorial that talk about that database, connect, align Superset topline features with same language as in GitHub
SUMMARY
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TEST PLAN
ADDITIONAL INFORMATION