Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-3975] [docs] Override baseurl when serving docs locally #2040

Closed
wants to merge 1 commit into from
Closed

[FLINK-3975] [docs] Override baseurl when serving docs locally #2040

wants to merge 1 commit into from

Conversation

dyanarose
Copy link
Contributor

Updating build_docs.sh to serve the docs locally with the correct url.
This change makes build_docs.sh run the equivalent serve command to build_docs.bat.

removing now unnecessary config file.

@StephanEwen
Copy link
Contributor

@uce Can you have a look at this?

@@ -54,7 +54,7 @@ JEKYLL_CMD="build"
while getopts ":p" opt; do
case $opt in
p)
JEKYLL_CMD="serve --config _config.yml,_local_preview_conf.yml --watch"
JEKYLL_CMD="serve --baseurl= --watch"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Just tried this out and it works as expected. I guess it was there, because older Jekyll versions didn't have support for this. @dyanarose, do know exactly what changed (if anything) between Jekyll versions?

+1 to apply this change after #2033 has been merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@uce It looks like the baseurl switch came in with 1.0 https://github.com/jekyll/jekyll/blob/0ee1a75d16265abc250d0747c5f93bf2ad2daa05/site/_docs/upgrading/0-to-2.md#baseurl.

I think serve not respecting the multiple config files may be a bug/feature with Jekyll as the docs say that serve takes all the same switches as build does. https://jekyllrb.com/docs/configuration/#serve-command-options. I'm looking to prove that when I get the chance and look into it to raise an issue to see if the code or the docs need changing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation :-) I'll merge this later today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants