Versions Compared

Old Version 4

changes.mady.by.user Dongjoon Hyun

Saved on

compared with

New Version 5

changes.mady.by.user Mariia Mykhailova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The code for our website is maintained in the $REEF_HOME/website directory, and thus updating the website generally follows the same process of creating a pull request on GitHub for some new feature or bug fix. Create a branch for the new website, make local changes, and then generate a pull request. There is one additional thing to do: publish the website contents on Apache svn. Detailed explanations on specific tasks, including the publishing step, are described below.

 

Adding new

...

API documentation (Java)

For each release, we are providing provide the corresponding Java API via javadoc. Run the following command at $REEF_HOME of a new release branch:

Code Block
languagebash
$ mvn javadoc:aggregate

HTML files will be generated under $REEF_HOME/target/site/apidocs. Move all files and folders from the new release's $REEF_HOME/target/site/apidocs to your PR branch's $REEF_HOME/website/target/staging/site/apidocs/$VERSION_NUM. For example, if the new release version is 0.14.0, then you would first run 'mvn javadoc:aggregate' at $REEF_HOME of the apache-reef-0.1214.0 source code. Then, you should move the generated files and folders to $REEF_HOME/website/target/staging/site/apidocs/0.14.0 of the reef source code (the branch you created). They will be uploaded with the new website content, during the publishing step described below.

Adding new API documentation (.NET)

For each release, we provide the corresponding .NET API.

Install Doxygen from http://www.stack.nl/~dimitri/doxygen/download.html. Run the following command at $REEF_HOME of a new release branch:

Code Block
languagebash
$ doxygen

HTML files will be generated under $REEF_HOME/target/apidoc_net. Move all files and folders from the new release's $REEF_HOME/target/apidoc_net to your PR branch's $REEF_HOME/website/target/staging/site/apidoc_net/$VERSION_NUM. For example, if the new release version is 0.14.0, then you would first run 'doxygen' at $REEF_HOME of the apache-reef-0.14.0 source code. Then, you should move the generated files and folders to $REEF_HOME/website/target/staging/site/apidoc_net/0.14.0 of the reef source code (the branch you created). They will be uploaded with the new website content, during the publishing step described below.

...