Documentation

This documentation is produced using Hugo. To make an update to the documentation, follow this process:

  1. If you have not already done so, clone the repository.

    $ git clone https://github.com/oracle/weblogic-kubernetes-operator

  2. Create a new branch.

    $ git checkout -b your-branch

  3. Make your documentation updates by editing the source files in documentation/site/content.

    Make sure you check in the changes from the documentation/site/content area only; do not build the site and check in the static files.

  4. If you wish to view your changes, you can run the site locally using these commands. The site will be available on the URL shown here:

    $ cd documentation/site
$ hugo server -b http://localhost:1313/weblogic-kubernetes-operator

    You can also run the runlocal.sh script in that directory to start the Hugo server locally.

  5. When you are ready to submit your changes, push your branch to origin and submit a pull request. Remember to follow the guidelines in the Contribute to the operator document.