[CONTENT] Reshaping: Converge into the layout of crate-clients-tools
#34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amotl
force-pushed
the
amo/absorb-tutorial-references
branch
from
abc5746
to
8f4ac5f
Compare
amotl
changed the title
amotl
changed the title
crate-clients-tools
amotl
commented
Feb 22, 2024
Comment on lines
228
to
238
| ```{toctree} | ||
| :hidden: | ||
|
|
||
| install/index | ||
| getting-started/index | ||
| admin/index | ||
| integrate/index | ||
|
|
||
| reference-architectures/index | ||
| topic/analysis/index | ||
| topic/timeseries/index | ||
| topic/ml/index | ||
| topic/testing | ||
|
|
||
| domain/index | ||
| integrate/index | ||
| ``` |
There was a problem hiding this comment.
@seut: The main toc tree is much clearer now, I like it.
This was referenced Feb 22, 2024
amotl
commented
Feb 22, 2024
- Integrations - Load and Export - System Metrics - Data Visualization - Business Intelligence - Machine Learning - Software Testing - Application Domains - Time Series Data - Machine Learning While the content is in a single place only, in order to avoid redundancy, the separate "Application Domains" section can be used to provide an alternative categorization/grouping perspective. In this section, you can cherry-pick specific content sections, in order to provide better guidance into corresponding topics, optionally selecting from content within "Integrations", or adding dedicated content like "Time Series Data", which just does not fit into "Integrations" well.
- Reference Architectures - Application Domains - Integrations
amotl
force-pushed
the
amo/reshape-layout
branch
from
2b4b45d
to
500c42b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About
Based on GH-29, this patch converges the recently added content into roughly the same layout/shape we curated at
crate-clients-tools, also using the same labels for the same things. See https://cratedb.com/docs/clients/.Preview
https://cratedb-guide--34.org.readthedocs.build/
Details
Properly order main section pillars. Doing it like this, it also has a pleasant visual apperance, without too much flapping.
That's the layout tree of corresponding 2nd-level categories. It may be refined on a subsequent iteration by input from others who are interested. For example, see @marijaselakovic's suggestion at GH-10.
Application Domains
Integrations
Notes
Notes about resolving the Integrations vs. Topics dilemma.
While the content is in a single place only, in order to avoid redundancy, the separate "Application Domains" section can now be used to provide an alternative categorization/grouping perspective, beyond "Integrations".
In this section, you can cherry-pick specific content sections, in order to provide better guidance into corresponding topics, optionally selecting from content within "Integrations", like "Machine Learning", or alternatively adding dedicated content like "Time Series Data", which physically does not fit into "Integrations" well.
/cc @karynzv, @marijaselakovic, @hammerhead, @hlcianfagna, @ckurze