Name: fusion-doc-builder
Owner: Lucidworks
Description: Docker container for building docs
Created: 2015-09-14 08:40:29.0
Updated: 2018-05-15 09:47:59.0
Pushed: 2018-05-15 09:47:58.0
Homepage: null
Size: 17
Language: Shell
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Docker container for building Lucidworks Fusion docs.
NOTE: This is a public repo.
Download and install the appropriate flavor of the Docker tools for your machine:
Details on this toolset are found in this Docker blogpost
This docker container will be used to build the Fusion documentation from the Lucidworks GitHub repo Lucidworks/Fusion-docs
.
GitHub provides two ways to clone a directory: Clone with SSH or Clone with HTTPS.
If you clone with HTTPS, git will prompt you for you GitHub login and password.
Cloning with SSH uses the SSH authentication agent, name ssh-agent
which uses the file ~/.ssh/id_rsa
.
id_rsa
file, run the command: ssh-keygen -t rsa -b 4096
.ssh-add
.On the MacOS, when the Docker app is running, the docker whale icon will be present in the top toolbar. If it isn't running, launch the Docker app from the Applications folder. Clicking on this icon opens the drop-down menu, choose “Open Kitematic”
Note: if Kitematic is not already installed, the Docker app will provide a download link. Use this to download the .zip file which contains the app. The Mac OS security won't allow this app run and it will fail with message that the download is corrupt. There is a workaround described here
Launch Docker, launch Kitematic.
22/tcp
, access URL localhost:32769
.ssh-add
.ssh -p <port> jenkins@<IP-address>
. The user “jenkins” has password “jenkins”.clone git@github.com:Lucidworks/Fusion-docs.git
cd Fusion-docs
git checkout <version-to-build>
./build.sh
.jekyll serve
Jekyll is a Ruby application and uses the following environment variable to locate jekyll and its components: PATH
, GEM_HOME
, GEM_PATHS
The following command sequence will set up the jekyll server in the docker container and serve the generated site
in directory Fusion-docs/jekyll/_site
:
ekyll
rt PATH=/usr/local/bundle/bin:$PATH
rt GEM_HOME=/usr/local/bundle
rt GEM_PATHS=/usr/local/bundle:/usr/local/lib/ruby/gems/2.3.0
ll serve --host 0.0.0.0 --skip-initial-build --no-watch
The Jekyll server runs on port 4000 by default. In Kitematic, find the access URL for the container's 4000/tcp
port.
For example if Kitematic lists localhost:32771
as the access URL,
to browse the documentation the browser request URL would be: http://<container port access url 32771/index.html
.
./build-print.sh
to generate the set of pdfs.docker cp
from your host machine command line:
er cp fusion-doc-builder:/home/jenkins/Fusion-docs/pdfs/Fusion_Documentation_3_0.pdf .