Contribute to the documentation

The WebLogic Remote Console documentation is produced using the Hugo static site generator. The webpages are created in markdown and hosted within the same repository as the WebLogic Remote Console. This makes it easy to suggest edits and improvements directly to the documentation.

To make an update to the documentation:

1. Clone the repository.

   $ git clone https://github.com/oracle/weblogic-remote-console
   

2. Create a new branch.

   $ git checkout -b <your-branch>
   

3. Make your changes to the documentation. Edit the markdown source files in hugo/staging/content.

4. Build the site locally to view your changes.

   cd hugo/staging
   hugo server -b http://localhost:1313/weblogic-remote-console
   

   View the local site at http://localhost:1313/weblogic-remote-console/.

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 WebLogic Remote Console document.

   Note

   Make sure that you only check in changes from the hugo/staging/content area. Do not build the site and try to commit the static files.