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

Cleanup table of contents for select documentation #3095

Merged
merged 1 commit into from Mar 20, 2020

Conversation

@electrum
Copy link
Member

electrum commented Mar 14, 2020

No description provided.

@cla-bot cla-bot bot added the cla-signed label Mar 14, 2020
@electrum electrum requested a review from mosabua Mar 14, 2020
Copy link
Member

mosabua left a comment

I kinda prefer if there is some entry about what the page is about before the ToC .. as a reader you first get an idea with an overview or intro paragraph and the ToC is like a list of more details. If the ToC is first you kinda missing the context for all the headers.

In a larger context I was hoping to do a pass of all pages at some stage and make a consistent usage of local ToC with the above in mind so I would actually leave the page as it is for now.

@electrum electrum force-pushed the electrum:docs-select branch from 12065c0 to 8c50ae7 Mar 20, 2020
@electrum

This comment has been minimized.

Copy link
Member Author

electrum commented Mar 20, 2020

The existing one is very ugly, to the point of being embarrassing. I would not have approved that change originally. So we can either do this, or we can remove the TOC until we have something better. Staying the the existing is not an option.

Existing:

existing

New:

new

@electrum

This comment has been minimized.

Copy link
Member Author

electrum commented Mar 20, 2020

@mosabua I agree with you in general, although this is the SELECT reference page. I'm willing to bet anyone looking at this already has a basic understanding of what this does.

I think we should change the documentation to include the inline table of contents on the right side, in a consistent way. The GitHub docs are a good example: https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions

@dain
dain approved these changes Mar 20, 2020
@electrum electrum merged commit 73c59fd into prestosql:master Mar 20, 2020
1 of 37 checks passed
1 of 37 checks passed
maven-checks (1.8) maven-checks (1.8)
Details
hive-tests (config-empty) hive-tests (config-empty)
Details
x (config-empty, suite-1) x (config-empty, suite-1)
Details
maven-checks (11) maven-checks (11)
Details
hive-tests (config-hdp3) hive-tests (config-hdp3)
Details
x (config-empty, suite-2) x (config-empty, suite-2)
Details
maven-checks (13) maven-checks (13)
Details
x (config-empty, suite-3) x (config-empty, suite-3)
Details
x (config-empty, suite-5) x (config-empty, suite-5)
Details
x (config-empty, suite-6-non-generic) x (config-empty, suite-6-non-generic)
Details
x (config-empty, suite-7-non-generic) x (config-empty, suite-7-non-generic)
Details
x (config-empty, suite-8-non-generic) x (config-empty, suite-8-non-generic)
Details
x (config-hdp3, suite-1) x (config-hdp3, suite-1)
Details
x (config-hdp3, suite-2) x (config-hdp3, suite-2)
Details
x (config-hdp3, suite-3) x (config-hdp3, suite-3)
Details
x (config-hdp3, suite-5) x (config-hdp3, suite-5)
Details
x (config-cdh5, suite-1) x (config-cdh5, suite-1)
Details
x (config-cdh5, suite-2) x (config-cdh5, suite-2)
Details
x (config-cdh5, suite-3) x (config-cdh5, suite-3)
Details
x (config-cdh5, suite-5) x (config-cdh5, suite-5)
Details
error-prone-checks error-prone-checks
Details
test-other-modules test-other-modules
Details
web-ui-checks web-ui-checks
Details
x (presto-main) x (presto-main)
Details
x (presto-tests) x (presto-tests)
Details
x (presto-tests -P ci-only) x (presto-tests -P ci-only)
Details
x (presto-raptor-legacy) x (presto-raptor-legacy)
Details
x (presto-accumulo) x (presto-accumulo)
Details
x (presto-cassandra) x (presto-cassandra)
Details
x (presto-hive,presto-orc) x (presto-hive,presto-orc)
Details
x (presto-hive,presto-parquet -P test-parquet) x (presto-hive,presto-parquet -P test-parquet)
Details
x (presto-mongodb,presto-kafka,presto-elasticsearch) x (presto-mongodb,presto-kafka,presto-elasticsearch)
Details
x (presto-redis) x (presto-redis)
Details
x (presto-sqlserver,presto-postgresql,presto-mysql) x (presto-sqlserver,presto-postgresql,presto-mysql)
Details
x (presto-phoenix,presto-iceberg) x (presto-phoenix,presto-iceberg)
Details
x (presto-kudu) x (presto-kudu)
Details
verification/cla-signed
Details
@electrum electrum deleted the electrum:docs-select branch Mar 20, 2020
@mosabua

This comment has been minimized.

Copy link
Member

mosabua commented Mar 20, 2020

Yeah. Agree .. I was already looking at adding general ToC on left and page specific ToC on right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.