docs: clean up markdown syntax for docusaurus 3 #17740
Open
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
(cherry picked from commit 854dccb)
vtlim
reviewed
Feb 21, 2025
| @@ -101,7 +101,7 @@ All of these community extensions can be downloaded using [pull-deps](../operati | |||
| |druid-momentsketch|Support for approximate quantile queries using the [momentsketch](https://github.com/stanford-futuredata/momentsketch) library|[link](../development/extensions-contrib/momentsketch-quantiles.md)| | |||
| |druid-tdigestsketch|Support for approximate sketch aggregators based on [T-Digest](https://github.com/tdunning/t-digest)|[link](../development/extensions-contrib/tdigestsketch-quantiles.md)| | |||
| |gce-extensions|GCE Extensions|[link](../development/extensions-contrib/gce-extensions.md)| | |||
| |prometheus-emitter|Exposes [Druid metrics](../operations/metrics.md) for Prometheus server collection (<https://prometheus.io/>)|[link](../development/extensions-contrib/prometheus.md)| | |||
| |prometheus-emitter|Exposes [Druid metrics](../operations/metrics.md) for Prometheus server collection (https://prometheus.io/)|[link](../development/extensions-contrib/prometheus.md)| | |||
There was a problem hiding this comment.
Suggested change
| |prometheus-emitter|Exposes [Druid metrics](../operations/metrics.md) for Prometheus server collection (https://prometheus.io/)|[link](../development/extensions-contrib/prometheus.md)| | |
| |prometheus-emitter|Exposes [Druid metrics](../operations/metrics.md) for [Prometheus](https://prometheus.io/) server collection |[link](../development/extensions-contrib/prometheus.md)| |
| @@ -68,7 +68,7 @@ A tableSpec defines a table | |||
| |--------------|---------------------|------------------------------------------------------------------------------------------------------------------------|----------|---------| | |||
| | `name` | String | The name of the column | yes | null | | |||
| | `dataType` | String | The type of the column. Can be any column data type that is available to Druid. Depends on what extensions are loaded. | no | null | | |||
| | `properties` | Map<String, Object> | the column's defined properties. Non properties defined at this time. | no | null | | |||
| | `properties` | Map<String, Object\> | the column's defined properties. Non properties defined at this time. | no | null | | |||
There was a problem hiding this comment.
If the > needs a backslash, do you also need to for lines 55-56?
| @@ -399,7 +399,7 @@ For details, see the Schema Registry [documentation](http://docs.confluent.io/cu | |||
| | type | String | Set value to `schema_registry`. | no | | |||
| | url | String | Specifies the URL endpoint of the Schema Registry. | yes | | |||
| | capacity | Integer | Specifies the max size of the cache (default = Integer.MAX_VALUE). | no | | |||
| | urls | Array<String\> | Specifies the URL endpoints of the multiple Schema Registry instances. | yes (if `url` is not provided) | | |||
| | urls | Array\<String\> | Specifies the URL endpoints of the multiple Schema Registry instances. | yes (if `url` is not provided) | | |||
There was a problem hiding this comment.
undo this change? the first \ shows up
There was a problem hiding this comment.
also applies to other instances throughout
| @@ -43,7 +43,7 @@ This expression language supports the following operators (listed in decreasing | |||
| |^|Binary power op| | |||
| |*, /, %|Binary multiplicative| | |||
| |+, -|Binary additive| | |||
| |<, <=, >, >=, ==, !=|Binary Comparison| | |||
| |<, ≤, >, ≥, ==, ≠|Binary Comparison| | |||
There was a problem hiding this comment.
The != shows up as ≠, not sure if that's intentional
| @@ -330,7 +330,7 @@ FROM ( | |||
| PARTITIONED BY ALL | |||
| ``` | |||
|
|
|||
| ## Ingest a JSON string as COMPLEX<json\> | |||
| ## Ingest a JSON string as COMPLEX\<json\> | |||
| @@ -24,15 +24,15 @@ title: "Release notes" | |||
|
|
|||
| <!--Replace {{DRUIDVERSION}} with the correct Druid version.--> | |||
|
|
|||
| Apache Druid {{DRUIDVERSION}} contains over $NUMBER_FEATURES new features, bug fixes, performance enhancements, documentation improvements, and additional test coverage from $NUMBER_OF_CONTRIBUTORS contributors. | |||
| Apache Druid \{\{DRUIDVERSION}} contains over $NUMBER_FEATURES new features, bug fixes, performance enhancements, documentation improvements, and additional test coverage from $NUMBER_OF_CONTRIBUTORS contributors. | |||
There was a problem hiding this comment.
This is showing up as Apache Druid {\32.0.0} contains
| @@ -148,7 +148,7 @@ From the Hadoop container's shell, run the following command to copy the Hadoop | |||
| cp /usr/local/hadoop/etc/hadoop/*.xml /shared/hadoop_xml | |||
| ``` | |||
|
|
|||
| From the host machine, run the following, where {PATH_TO_DRUID} is replaced by the path to the Druid package. | |||
| From the host machine, run the following, where \{PATH_TO_DRUID\} is replaced by the path to the Druid package. | |||
There was a problem hiding this comment.
Does this get interpreted at build or later? I see
From the host machine, run the following, where {PATH_TO_DRUID} is replaced by the path to the Druid package.
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.
Used the docusaurus syntax checker to clean up the errors so that the site will comply with MDX v3
This update to the build/copy script in
druid-website-srcneeds to be reviewed and merged to accomdodate the escaped DRUIDVERSION variable: apache/druid-website-src#519The best way to review this is concurrently with 519. Run the do all things script in 519 and verify the prod output with
yarn/npm run serveThis PR has: