You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "317brian (via GitHub)" <gi...@apache.org> on 2023/06/12 22:47:32 UTC
[GitHub] [druid] 317brian opened a new pull request, #14411: Docusaurus2
317brian opened a new pull request, #14411:
URL: https://github.com/apache/druid/pull/14411
### Description
This PR updates master to Docusaurus 2. It backs up the previous website directory to `website_old`. We can delete it after we’re ready to merge this PR.
Related PRs:
- There will be a separate PR that also upgrades the 26.0.0 release branch (Will add link once it's opened)
- A PR that upgrades `druid-website-src` to Docusaurus 2. (Will add link once it's opened)
- PR that proposes a new publishing process: https://github.com/apache/druid-website-src/pull/392
### Benefits
- No longer EOL backend!
- More nesting in the side nav
- Support for extended Markdown (MDX), which lets you add Javascript to Markdown pages.
### Changed
- The Markdown parser is stricter for Docusaurus2. Impacted docs have already been updated.
- The format of redirects. To add a new redirect, follow the ones that have already been converted in website/redirects.json in this PR.
- Sidebar syntax
- `subcategory` -> `category`
- `ids` -> `items`
- The [tab syntax](https://docusaurus.io/docs/markdown-features/tabs#customizing-tab-headings) used for things like showing the curl and Python equivalent API calls.
- The new config file for the site settings is `website/docusaurus.config.js`
### Stayed the same
- Install Docusaurus with `npm/yarn install` and run the site with `npm/yarn start`.
- All the website pages, like the home page and "Downloads" page are still in `apache/druid-website-src`.
- The source of truth for the CSS and styling of the prod site is `apache/druid-website-src`. I didn’t see a need to style this repo since the main concern would be the Markdown rendering correctly, and they both use the same Markdown parser.
- `druid-website-src` still builds the production site
- This repo is the source of truth for the docs, sidebar, and redirects.
### Need help on the following:
The link checking script and broken link behavior. I copied the link checking script over and updated the path to actually point at the build output from `npm run build`, but the output is different depending on how the filepath is declared:
- `const entries = fg.sync(['./build/docs/**/*.html'])` results in:`There are 13232 issues`. That's definitely wrong
- `const entries = fg.sync(['./build/docs/latest/*.html'])` results in 1 issue: `Could not find '/docs/latest/design/' linked from './build/docs/latest/index.html`. I think the issue is that it's not going through the directories recursively, so it can't find the file. But if we do the `**` instead of `latest`, we get 13k issues.
Neither of these are the actual link I broke intentionally to test the link checker, which Docusaurus 2 detects when you run `npm start`:
```
[INFO] Docs markdown link couldn't be resolved: (./bob.md) in "/Users/brian/my-druid-fork/docs/ingestion/ingestion-spec.md" for version current
```
In the meantime, we can configure Docusaurus 2 to do a one of 2 things on broken links when someone runs the site or tries to build it:
We can either set it to log a command line msg like so:
[WARNING] Docs markdown link couldn't be resolved: (../ingestion/in.md) in "/Users/brian/my-druid-fork/docs/tutorials/index.md" for version current
Or we can surface an error in the rendered site:
The user can close the error and navigate around the site still.
<hr>
<!-- Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist below are strictly necessary, but it would be very helpful if you at least self-review the PR. -->
This PR has:
- [x] been self-reviewed.
- [ ] using the [concurrency checklist](https://github.com/apache/druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.)
Thanks @ektravel, @writer-jill, @techdocsmith, and @vtlim for helping get this together.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1850660683
Hi @xvrl, this removed the pom.xml for the website directory cause the Druid docs for staging/production aren't built in this repo anymore: https://github.com/apache/druid/pull/15113#issuecomment-1770054516
I forgot to do that piece of the followup. I'll put up a PR that deletes the profile.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "xvrl (via GitHub)" <gi...@apache.org>.
xvrl commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1850651708
@techdocsmith @317brian it looks like this removed the website/pom.xml but I couldn't find an explanation for that. This seems to have broken dependabot, because the module is still referenced in one of the maven profiles in the main `pom.xml`. It's fine if we want to remove the maven build for the website, but can we at least add a comment to explain why we removed it? Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on pull request #14411: Docusaurus2 upgrade for master
Posted by "petermarshallio (via GitHub)" <gi...@apache.org>.
petermarshallio commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1590750775
... and then I noticed @317brian that
a) The header is white, so the Druid logo isn't happy.
b) there's a section called "hidden" - is this expected?
<img width="987" alt="image" src="https://github.com/apache/druid/assets/42997954/fda3ce20-5f89-4379-bb35-760794d802a1">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1644515752
We need to fix some markdown syntax from doc refactors that got merged into `master`. Will comment when that's done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] 317brian commented on a diff in pull request #14411: Docusaurus2 upgrade for master
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1229851395
##########
README.md:
##########
@@ -89,6 +89,10 @@ See the [latest documentation](https://druid.apache.org/docs/latest/) for the do
Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [MarkDown](https://www.markdownguide.org/) and contribute them using a pull request.
+The documentation site is built using Docusaurus2. Install Docusaurus2 by running one of the following in `website`: `npm install` or `yarn install`. Then, run `npm start` or `yarn start` in `website/` to see a local preview of your changes.
Review Comment:
Sure, I can update this to add the required Node version.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1291755736
##########
docs/querying/filters.md:
##########
@@ -111,6 +113,7 @@ Druid's SQL planner uses the null filter by default instead of selector filter w
{ "type": "null", "column": "someColumn" }
```
+[bob](asdf.md)
Review Comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1626060819
@techdocsmith and I did a little investigating of the link checker. Part of the issue is that the link checker expects the `.html` extension for links, but Docusaurus 2 omits them, which I think is inline with the expectation of most ppl.
For example
```
/docs/latest/ingestion/input-sources' linked from './build/docs/latest/development/extensions-core/s3/index.html'
```
That's a valid link but the link checker says it's invalid because it doesn't include the extension.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on pull request #14411: Docusaurus2 upgrade for master
Posted by "petermarshallio (via GitHub)" <gi...@apache.org>.
petermarshallio commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1590747309
Looking good!!
I added a note to suggest that the instructions include the required node version.
Additionally I noted that all admonitions (currently tagged `>`) don't stand out as much as they used to (in yellow). I read that Docusaurus 2 allows for several types, and tested one out (see below) but maybe working out what type each one is (!) is a job for another day?
<img width="987" alt="image" src="https://github.com/apache/druid/assets/42997954/fa52d276-38ec-4a59-be82-3d1b74382096">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1675231919
@vtlim and @techdocsmith can you review and approve this PR:
Check out the PR and do `npm start` and `npm run build` in `website` to verify the docs build
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on a diff in pull request #14411: Docusaurus2 upgrade for master
Posted by "petermarshallio (via GitHub)" <gi...@apache.org>.
petermarshallio commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1229226376
##########
README.md:
##########
@@ -89,6 +89,10 @@ See the [latest documentation](https://druid.apache.org/docs/latest/) for the do
Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [MarkDown](https://www.markdownguide.org/) and contribute them using a pull request.
+The documentation site is built using Docusaurus2. Install Docusaurus2 by running one of the following in `website`: `npm install` or `yarn install`. Then, run `npm start` or `yarn start` in `website/` to see a local preview of your changes.
Review Comment:
Perhaps because of my lack of knowledge (!!!) I ran into an issue starting the docs here because I was still using node 10 (as per https://github.com/apache/druid-website-src/blob/master/README.md) - so perhaps state here which version of node is required to run Docusaurus?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1648644739
Markdown issues resolved
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "clintropolis (via GitHub)" <gi...@apache.org>.
clintropolis commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1295236945
##########
website_old/README.md:
##########
@@ -0,0 +1,72 @@
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+
+# Druid doc builder
Review Comment:
why do we still need 'website_old' path and small set of files? since this was already merged into a release branch it seems safe to just dump it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "vtlim (via GitHub)" <gi...@apache.org>.
vtlim commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1294013984
##########
README.md:
##########
@@ -87,7 +87,11 @@ Use the built-in query workbench to prototype [DruidSQL](https://druid.apache.or
See the [latest documentation](https://druid.apache.org/docs/latest/) for the documentation for the current official release. If you need information on a previous release, you can browse [previous releases documentation](https://druid.apache.org/docs/).
-Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [MarkDown](https://www.markdownguide.org/) and contribute them using a pull request.
+Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [MarkDown](https://www.markdownguide.org/) or extended Markdown [(MDX)](https://mdxjs.com/). Then, open a pull request.
Review Comment:
```suggestion
Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [Markdown](https://www.markdownguide.org/) or extended Markdown [(MDX)](https://mdxjs.com/). Then, open a pull request.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "clintropolis (via GitHub)" <gi...@apache.org>.
clintropolis commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1295236945
##########
website_old/README.md:
##########
@@ -0,0 +1,72 @@
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+
+# Druid doc builder
Review Comment:
why do we need 'website_old' path and small set of files?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] 317brian commented on pull request #14411: Docusaurus2 upgrade for master
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1591532708
Thanks for taking a look @petermarshallio!
* For admonitions: yes, Docusaurus does support different types of them, and we can sort out the different ones in a follow up PR.
* This repo is unstyled because it's purpose is to provide a preview of the rendered markdown. The repo that builds the prod site, `apache/druid-website-src`, the styling has been implemented: https://deploy-preview-1--frabjous-kulfi-9f6ae5.netlify.app/. We'll have a follow up PR to style this.
* The hidden section, thanks for catching that! I must have missed deleting it from this PR. The pages will still get built after I delete them, but they aren't shown in the sidebar on the current live site.
* Thanks for testing the scripts! I'll look into the spellcheck one. Will need someone else to chime in about the link checker cause I have open questions about that one too.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "techdocsmith (via GitHub)" <gi...@apache.org>.
techdocsmith merged PR #14411:
URL: https://github.com/apache/druid/pull/14411
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "vtlim (via GitHub)" <gi...@apache.org>.
vtlim commented on code in PR #14411:
URL: https://github.com/apache/druid/pull/14411#discussion_r1294015145
##########
distribution/asf-release-process-guide.md:
##########
@@ -370,20 +370,37 @@ $ svn commit -m 'add 0.17.0-rc3 artifacts'
### Update druid.staged.apache.org
+This repo is the source of truth for the Markdown files. The Markdown files get copied to `druid-website-src` and built there as part of the release process. It's all handled by a script in that repo called `do_all_things`.
+
+For more thorough instructions and a description of what the `do_all_things` script does, see the [`druid-website-src` README](https://github.com/apache/druid-website-src)
+
1. Pull https://github.com/apache/druid-website and https://github.com/apache/druid-website-src. These repositories should be in the same directory as your Druid repository that should have the release tag checked out.
-2. From druid-website, checkout branch `asf-staging`.
+2. From `druid-website`, checkout branch `asf-staging`.
-3. From druid-website-src, create a release branch from `master` and run `./release.sh 0.17.0 0.17.0`, replacing `0.17.0` where the first argument is the release version and 2nd argument is commit-ish. This script will:
+3. From `druid-website-src`, create a release branch from `master`, such as `27.0.0-docs`.
+ 1. Update the version list in `static/js/version`.js with the version you're releasing and the release date. The highest release version goes in position 0.
+ 1. In `scripts`, run:
+
+ ```python
+ # Include `--skip-install` if you already have Docusaurus 2 installed in druid-website-src.
+ # The script assumes you use `npm`. If you use`yarn`, include `--yarn`.
Review Comment:
```suggestion
# The script assumes you use `npm`. If you use `yarn`, include `--yarn`.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "xvrl (via GitHub)" <gi...@apache.org>.
xvrl commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1850664838
no worries @317brian, I already have a PR up to remove the module here https://github.com/apache/druid/pull/15540
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1675376268
[`f6ec159` (#14411)](https://github.com/apache/druid/pull/14411/commits/f6ec1591c2d39c30cfd40f962840f70cdf17b631) works as intended. The CI failed with the errant link in the output. Will revert the fake link I put in.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1675365643
Updated `asf-release-process-guide.md` too, so that's also ready for review.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on pull request #14411: Docusaurus2 upgrade for master
Posted by "petermarshallio (via GitHub)" <gi...@apache.org>.
petermarshallio commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1590764201
WRT /docs/latest/development/contribute-to-docs:
```
petermarshall@peter-marshall website % npm run link-lint
> link-lint
> npm run build && node script/link-lint.js
> build
> docusaurus build
file:///Users/petermarshall/GitHub/petermarshallio/druid/website/node_modules/@docusaurus/core/bin/docusaurus.mjs:30
process.env.BABEL_ENV ??= 'development';
^^^
SyntaxError: Unexpected token '??='
at Loader.moduleStrategy (internal/modules/esm/translators.js:145:18)
at async link (internal/modules/esm/module_job.js:67:21)
```
I got this with `npm run spellcheck`:
```
petermarshall@peter-marshall website % npm run spellcheck
> spellcheck
> mdspell --en-us --ignore-numbers --report '../docs/**/*.md' || (./script/notify-spellcheck-issues && false)
../docs/api-reference/sql-ingestion-api.md
7 | import TabItem from '@theme/TabItem';
7 | import TabItem from '@theme/TabItem';
../docs/querying/datasource.md
7 | import TabItem from '@theme/TabItem';
7 | import TabItem from '@theme/TabItem';
../docs/querying/nested-columns.md
7 | import TabItem from '@theme/TabItem';
7 | import TabItem from '@theme/TabItem';
../docs/tutorials/tutorial-unnest-arrays.md
8 | import TabItem from '@theme/TabItem';
8 | import TabItem from '@theme/TabItem';
>> 8 spelling errors found in 228 files
sh: ./script/notify-spellcheck-issues: No such file or directory
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Docusaurus2 upgrade for master (druid)
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #14411:
URL: https://github.com/apache/druid/pull/14411#issuecomment-1631439915
Based on a discussion with @vogievetsky and @techdocsmith, we'll disable the link checker CI step and use the OOTB feature of Docusaurus 2 to throw an error on build when it encounters a broken link.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org