docs: fix html nits #13835

317brian · 2023-02-22T22:15:25Z

Description

Really minor fixes like closing the <br /> tag in preparation for Docusaurus2, which doesn't like it when they're not closed.

This PR has:

been self-reviewed.

(cherry picked from commit 882e12a)

jwitko · 2023-02-22T22:19:51Z

Hey @317brian I have #13747 failing on a static CI check for something that looks appropriate for this PR and I'm guessing it will fail for you as well?

> spellcheck
> mdspell --en-us --ignore-numbers --report '../docs/**/*.md' || (./script/notify-spellcheck-issues && false)

    ../docs/tutorials/tutorial-jupyter-index.md
       41 | er both try to use port `8888,` so start Jupyter on a different port 

>> 1 spelling error found in 227 files

Although to be fair I have no idea what its upset about? Seems to be complaining about this line

317brian · 2023-02-22T22:24:26Z

Yeah, someone else was running into this earlier. It passes spellcheck locally, but for some reason the GHA doesn't like the position of the comma. It wants it outside of the `, which is technically correct but looks odd in the rendered output.

abhishekrb19 · 2023-02-23T06:41:04Z

@317brian @jwitko, yeah, I ran into the same spellcheck failure. spellcheck assumed there was a huge codeblock with an incorrect syntax because of an additional backtick that got accidentally introduced. It's now fixed in master; if you pull the top of master, that should have the fix #13838.

paul-rogers · 2023-02-23T16:38:17Z

docs/ingestion/migrate-from-firehose-ingestion.md

@@ -53,7 +53,7 @@ Edit the new file as follows:
 4. Move the `format` definition from `parser.parseSpec` to an `inputFormat` definition in `ioConfig`.
 5. Delete the `parser` definition.
 6. Save the file.
-<br>You can check the format of your new ingestion file against the [migrated example](#example-ingestion-spec-after-migration) below.
+<br />You can check the format of your new ingestion file against the [migrated example](#example-ingestion-spec-after-migration) below.


Break here isn't really needed. Reads better without it.

paul-rogers · 2023-02-23T16:42:14Z

docs/ingestion/ingestion-spec.md

@@ -477,7 +477,7 @@ The `indexSpec` object can include the following properties:
 |-----|-----------|-------|
 |bitmap|Compression format for bitmap indexes. Should be a JSON object with `type` set to `roaring` or `concise`. For type `roaring`, the boolean property `compressRunOnSerialization` (defaults to true) controls whether or not run-length encoding will be used when it is determined to be more space-efficient.|`{"type": "roaring"}`|
 |dimensionCompression|Compression format for dimension columns. Options are `lz4`, `lzf`, `zstd`, or `uncompressed`.|`lz4`|
-|stringDictionaryEncoding|Encoding format for STRING value dictionaries used by STRING and COMPLEX&lt;json&gt; columns. <br>Example to enable front coding: `{"type":"frontCoded", "bucketSize": 4}`<br>`bucketSize` is the number of values to place in a bucket to perform delta encoding. Must be a power of 2, maximum is 128. Defaults to 4.<br>See [Front coding](#front-coding) for more information.|`{"type":"utf8"}`|
+|stringDictionaryEncoding|Encoding format for STRING value dictionaries used by STRING and COMPLEX&lt;json&gt; columns. <br />Example to enable front coding: `{"type":"frontCoded", "bucketSize": 4}`<br />`bucketSize` is the number of values to place in a bucket to perform delta encoding. Must be a power of 2, maximum is 128. Defaults to 4.<br />See [Front coding](#front-coding) for more information.|`{"type":"utf8"}`|


Breaks here do seem to be needed: at least the VS Code preview gets confused with newlines within a table.

Elsewhere in this table we use two breaks to create a clear separation between paragraphs. Should we do that here as well for consistency? The resulting text looks better.

paul-rogers · 2023-02-23T16:45:41Z

docs/operations/rule-configuration.md

-<br>You can use this property to load segments with future start and end dates, where "future" is relative to the time when the Coordinator evaluates data against the rule. Defaults to `true`.
+<br />- the segment interval overlaps the rule interval, or
+<br />- the segment interval starts any time after the rule interval starts.
+<br />You can use this property to load segments with future start and end dates, where "future" is relative to the time when the Coordinator evaluates data against the rule. Defaults to `true`.


At the cost of extra per-line spacing, you can replace the <br /> above with two spaces and get the same effect in a more Markdown-ish way. Here and below.

paul-rogers · 2023-02-23T16:48:17Z

docs/tutorials/tutorial-kafka.md

@@ -45,7 +45,7 @@ Before you follow the steps in this tutorial, download Druid as described in the
   ```
 2. If you're already running Kafka on the machine you're using for this tutorial, delete or rename the `kafka-logs` directory in `/tmp`.

-   > Druid and Kafka both rely on [Apache ZooKeeper](https://zookeeper.apache.org/) to coordinate and manage services. Because Druid is already running, Kafka attaches to the Druid ZooKeeper instance when it starts up.<br>
+   > Druid and Kafka both rely on [Apache ZooKeeper](https://zookeeper.apache.org/) to coordinate and manage services. Because Druid is already running, Kafka attaches to the Druid ZooKeeper instance when it starts up.<br />


This reads better as:

> Druid and Kafka both rely on ... > > In a production environment ...

No need for the <br/>, but no harm either.

paul-rogers

LGTM

paul-rogers · 2023-02-23T22:30:44Z

docs/tutorials/tutorial-kafka.md

@@ -45,7 +45,7 @@ Before you follow the steps in this tutorial, download Druid as described in the
   ```
 2. If you're already running Kafka on the machine you're using for this tutorial, delete or rename the `kafka-logs` directory in `/tmp`.

-   > Druid and Kafka both rely on [Apache ZooKeeper](https://zookeeper.apache.org/) to coordinate and manage services. Because Druid is already running, Kafka attaches to the Druid ZooKeeper instance when it starts up.<br>
+   > Druid and Kafka both rely on [Apache ZooKeeper](https://zookeeper.apache.org/) to coordinate and manage services. Because Druid is already running, Kafka attaches to the Druid ZooKeeper instance when it starts up.<br />


No need for the <br/>, but no harm either.

317brian · 2023-02-23T23:02:38Z

The step in CI that's failing is the license check

Error: found 1 missing licenses. These licenses are reported, but missing in the registry
druid_module: avro-extensions, groupId: com.sun.activation, artifactId: jakarta.activation, version: 1.2.1, license: Eclipse Distribution License 1.0

It's unlikely to be caused by this PR since this PR only touches files in docs and not the avro-extension. The PR also doesn't add any new files that would need a license.

317brian added 2 commits February 6, 2023 15:31

fix markdown issues

20922d9

gha: add auto labeler for doc prs

f110fe1

(cherry picked from commit 882e12a)

github-actions bot added the Area - Documentation label Feb 22, 2023

Merge branch 'master' into html-nits

495b228

move comma outside the tick

b255cfa

vtlim approved these changes Feb 22, 2023

View reviewed changes

paul-rogers reviewed Feb 23, 2023

View reviewed changes

317brian added 3 commits February 23, 2023 09:08

address feedback from paul

0d57927

fix merge

cd752bc

fix list syntax in rules-config

6b9e4cb

paul-rogers approved these changes Feb 23, 2023

View reviewed changes

vtlim merged commit b4b354b into apache:master Mar 2, 2023

317brian deleted the html-nits branch March 2, 2023 19:19

317brian added a commit to 317brian/druid that referenced this pull request Mar 10, 2023

docs: fix html nits (apache#13835)

ddc9971

clintropolis added this to the 26.0 milestone Apr 10, 2023

vtlim mentioned this pull request Jun 14, 2023

[Docs] Clean up druid.processing.intermediaryData.storage.type description #14431

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix html nits #13835

docs: fix html nits #13835

317brian commented Feb 22, 2023 •

edited

jwitko commented Feb 22, 2023

317brian commented Feb 22, 2023

abhishekrb19 commented Feb 23, 2023 •

edited

paul-rogers Feb 23, 2023

paul-rogers Feb 23, 2023

paul-rogers Feb 23, 2023

paul-rogers Feb 23, 2023

paul-rogers Feb 23, 2023

paul-rogers left a comment

paul-rogers Feb 23, 2023

317brian commented Feb 23, 2023

docs: fix html nits #13835

docs: fix html nits #13835

Conversation

317brian commented Feb 22, 2023 • edited

Description

jwitko commented Feb 22, 2023

317brian commented Feb 22, 2023

abhishekrb19 commented Feb 23, 2023 • edited

paul-rogers Feb 23, 2023

Choose a reason for hiding this comment

paul-rogers Feb 23, 2023

Choose a reason for hiding this comment

paul-rogers Feb 23, 2023

Choose a reason for hiding this comment

paul-rogers Feb 23, 2023

Choose a reason for hiding this comment

paul-rogers Feb 23, 2023

Choose a reason for hiding this comment

paul-rogers left a comment

Choose a reason for hiding this comment

paul-rogers Feb 23, 2023

Choose a reason for hiding this comment

317brian commented Feb 23, 2023

317brian commented Feb 22, 2023 •

edited

abhishekrb19 commented Feb 23, 2023 •

edited