You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "vtlim (via GitHub)" <gi...@apache.org> on 2023/08/04 20:59:20 UTC
[GitHub] [druid-website-src] vtlim opened a new pull request, #410: Add publishing option for updating site without docs
vtlim opened a new pull request, #410:
URL: https://github.com/apache/druid-website-src/pull/410
Use the `--no-docs` flag if you want to use the publish script to update the site (e.g., home page) without any change in the documentation
Example:
```
python do_all_things.py -v 27.0.0 --no-docs
```
--
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-website-src] 317brian commented on pull request #410: Add publishing option for updating site without docs
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on PR #410:
URL: https://github.com/apache/druid-website-src/pull/410#issuecomment-1670463975
Tested the new --no-docs option, and it worked
@vogievetsky this adds a new option to the build script for if the goal is to update the website pages (such as the homepage) cause there are new events etc and there's not a need to update the doc pages too
It uses the Markdown files already in `docs/latest` and builds only latest, so it should run a little quicker than the other options.
We've also updated the README to be more explicit about needing to commit the built files to the repo so that subsequent releases don't need to rebuild older versions.
--
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-website-src] 317brian commented on a diff in pull request #410: Add publishing option for updating site without docs
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on code in PR #410:
URL: https://github.com/apache/druid-website-src/pull/410#discussion_r1287727145
##########
README.md:
##########
@@ -50,11 +50,30 @@ These are the steps to publish either a new release or a hotfix to an existing r
4. In `scripts`, run `python do_all_things.py -v VERSION`. The script assumes you used `npm` to install. See example 3 if you use `yarn`.
- **Example 1**: `python do_all_things.py -v 26.0.0`. This command builds version 26.0.0 of the docs and latest.
-
- **Example 2**: If you already have Docusaurus 2 installed, skip the installation by specifying the flag `--skip-install`. For example, `python do_all_things.py -v 26.0.0 --skip-install`
-
- **Example 3**: If you want to use yarn instead of npm, specify the flag `--yarn`. For example, `python do_all_things.py -v 26.0.0 --skip-install --yarn`
+ **Example 1**: This command builds version 27.0.0 of the docs and latest.
+ ```
+ python do_all_things.py -v 27.0.0
+ ```
+
+ **Example 2**: If you already have Docusaurus 2 installed, skip the installation by specifying the flag `--skip-install`.
+ ```
+ python do_all_things.py -v 27.0.0 --skip-install
+ ```
+
+ **Example 3**: If you want to use yarn instead of npm, specify the flag `--yarn`.
+ ```
+ python do_all_things.py -v 27.0.0 --yarn
+ ```
+
+ **Example 4**: If you have apache/druid in a completely different place (see note above), specify it using the `--source` flag.
+ ```
+ python do_all_things.py -v 27.0.0 --source /my/path/to/apache/druid
+ ```
+
+ **Example 5**: If you want to skip all the source docs (don't copy them from apache/druid), use the `--no-docs` flag.
Review Comment:
```suggestion
**Example 5**: If you want to use the Markdown files already in this repo because you don't need to publish doc changes, use the `--no-docs` flag. The script will use the docs already in `docs/latest` to build the site. Use this if you need to republish the site to update the homepage widgets or other non-doc website pages.
```
* Probably update the updating the homepage widgets section section to mention that if all you need to do is update the data for the homepage widgets, use the `--no-docs` flag when running `do_all_the_things` script.
* Remove `27.0.0` from the example since the intent is that this flag is primarily used for updating the website pages, which means we only need to build latest.
--
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-website-src] vogievetsky merged pull request #410: Add publishing option for updating site without docs
Posted by "vogievetsky (via GitHub)" <gi...@apache.org>.
vogievetsky merged PR #410:
URL: https://github.com/apache/druid-website-src/pull/410
--
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