You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/05/26 20:53:13 UTC
[jira] [Commented] (FLINK-3975) docs build script isn't serving the
preview on the correct base url
[ https://issues.apache.org/jira/browse/FLINK-3975?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15302897#comment-15302897 ]
ASF GitHub Bot commented on FLINK-3975:
---------------------------------------
GitHub user dyanarose opened a pull request:
https://github.com/apache/flink/pull/2040
[FLINK-3975] [docs] Override baseurl when serving docs locally
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.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/dyanarose/flink FLINK-3975
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/2040.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #2040
----
commit 96af1da4e4770f2e6ed18d8413a6ea106927606e
Author: Dyana Rose <dy...@gmail.com>
Date: 2016-05-26T20:40:07Z
[FLINK-3975] [docs] Override baseurl when serving docs locally
----
> docs build script isn't serving the preview on the correct base url
> -------------------------------------------------------------------
>
> Key: FLINK-3975
> URL: https://issues.apache.org/jira/browse/FLINK-3975
> Project: Flink
> Issue Type: Bug
> Components: Documentation
> Environment: centos 7.2, jekyll 3.1.6, ruby 2.3.1
> Reporter: Dyana Rose
> Priority: Trivial
>
> when running the documentation build script as:
> {{./build_docs.sh -p}} the docs are built using the correctly overridden baseurl, but they are then served from the wrong url making it a wee bit more difficult than intended to review changes locally.
> The following is the output from running the script:
> {quote}
> Configuration file: _config.yml
> Configuration file: _local_preview_conf.yml
> Source: /vagrant/flink/docs
> Destination: /vagrant/flink/docs/target
> Incremental build: disabled. Enable with --incremental
> Generating...
> /home/vagrant/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/pygments.rb-0.6.3/lib/pygments/popen.rb:57: warning: Insecure world writable dir /opt/scala-2.11.8/bin in PATH, mode 040777
> done in 16.736 seconds.
> Auto-regeneration: enabled for '/vagrant/flink/docs'
> Configuration file: /vagrant/flink/docs/_config.yml
> Server address: http://0.0.0.0:4000//ci.apache.org/projects/flink/flink-docs-master/
> Server running... press ctrl-c to stop.
> {quote}
> As you see it looks to be using both config files to build, but only the default config file to serve.
> This can be fixed by just removing the {{_local_preview_conf.yml}} file and instead specify the baseurl as an option to the serve command, so it becomes {{serve --config _config.yml --baseurl= --watch}}. Giving an output of:
> {quote}
> Configuration file: _config.yml
> Source: /vagrant/flink/docs
> Destination: /vagrant/flink/docs/target
> Incremental build: disabled. Enable with --incremental
> Generating...
> /home/vagrant/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/pygments.rb-0.6.3/lib/pygments/popen.rb:57: warning: Insecure world writable dir /opt/scala-2.11.8/bin in PATH, mode 040777
> done in 15.928 seconds.
> Auto-regeneration: enabled for '/vagrant/flink/docs'
> Configuration file: /vagrant/flink/docs/_config.yml
> Server address: http://0.0.0.0:4000/
> Server running... press ctrl-c to stop.
> {quote}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)