Shingo Furuyama ee7fdfc45d [MINOR] Modify the description of POST /sessions/{sessionId}/completion | há 4 anos atrás | |
---|---|---|
.. | ||
_data | há 4 anos atrás | |
_includes | há 7 anos atrás | |
_layouts | há 7 anos atrás | |
_plugins | há 6 anos atrás | |
assets | há 7 anos atrás | |
Gemfile | há 7 anos atrás | |
Gemfile.lock | há 6 anos atrás | |
README.md | há 6 anos atrás | |
_config.yml | há 7 anos atrás | |
index.md | há 7 anos atrás | |
programmatic-api.md | há 5 anos atrás | |
rest-api.md | há 4 anos atrás |
This documentation is generated using Jekyll.
The steps below will install the latest Jekyll version and any dependencies required to get this documentation built.
1. sudo gem install jekyll bundler
2. cd docs
3. sudo bundle install
For more information, see Installing Jekyll.
Before opening a pull request, you can preview your contributions by running from within the directory:
1. cd docs
2. bundle exec jekyll serve --watch
3. Open http://localhost:4000
You can build just the Livy javadocs by running mvn javadoc:aggregate
from the LIVY_HOME
directory, or the Livy scaladocs by running mvn scala:doc
in certain modules. (Scaladocs do
not currently build in every module)
When you run jekyll build
in the docs
directory, it will also copy over the scaladocs and
javadocs for the public APIs into the docs
directory (and then also into the _site
directory).
We use a jekyll plugin to run the api builds before building the site so if you haven't run it
(recently) it may take some time as it generates all of the scaladoc and javadoc using Maven.
NOTE: To skip the step of building and copying over the Scala and Java API docs, run SKIP_API=1
jekyll build
.
cd docs
then bundle exec jekyll build
).docs/target/
excluding assets/
into a new directory (eg. 0.4.0/
) and
move it into the docs/
directory in your local fork of apache/incubator-livy-website
.latest
symlink to point to the new directory.apache/incubator-livy-website
with the update.Note: If you made any changes to files in the assets/
directory you will need to replicate those
changes in the corresponding files in apache/incubator-livy-website
in the pull request.