Domino REST API documentation

Usage

View the documentation for product features and usage information.

Contributing

You are welcome to report bugs or provide feedback on the product documentation using pull requests on GitHub at https://github.com/HCL-TECH-SOFTWARE/Domino-rest-api. This is the Domino REST API product documentation website and not the product support platform, so all bug reports and pull requests shall pertain to product documentation. You are expected to update only the markdown files in the docs directory.

How to contribute?

Perform the following steps to contribute to the documentation.

Update the documentation

1. Clone the Domino REST API documentation repo.

   If you do not have write access to the repo, fork the repository and then clone your forked repository.

2. Create a new working branch for your changes.

3. Edit the Markdown files (.md) in the docs directory that you want to update using your preferred text or code editor, and then save the changes.

Validate your changes

The Domino REST API documentation is built using MKDocs with the Material for MKDocs theme. For local validation and testing, it is recommended to use a Visual Studio Code dev container.

Make sure to install the Dev Containers extension for Visual Studio Code.

1. Run makedocker.sh to create a Docker image called keepdocs:latest.

   Dockerfile and makedocker scripts are included in the repository to build the required Docker image. Macs with M1 chips need a different base image, so M1 users must use the M1-specific scripts and images.

2. Create a .devcontainer directory in the root of the repo.

3. Create a devcontainer.json file in the .devcontainer directory. The devcontainer.json file has the following content:

   {
   "image": "keepdocs:latest"
   }

   Make sure to change the image tag if you used the M1-variant script.

4. Open the Command Palette, and then search for and select Dev Containers: Reopen in Container.

   VS Code will reopen with your project folder loaded inside the container. You can confirm this by opening the Terminal in VS Code, where the working directory path will start with "/workspaces/".

5. Run the command mkdocs serve and then open https://localhost:8000 in your browser to check your changes.

Submit your documentation changes

1. Stage and commit your changes with a clear commit message.

2. Push your branch to remote Domino REST API repo.

   In case you created your branch from your fork, push your branch to your fork of the Domino REST API repository.

3. Navigate to the Domino REST API repo on GitHub, then create a pull request (PR) from your branch targeting the main branch.

   In case you pushed your branch to your fork of the Domino REST API repository, see create a pull request from a fork.

4. Respond to review comments and update your PR as needed until approved.

Once the pull request is approved and merged, your changes will be published on the documentation site.

Raising Issues

If you find any inaccuracies on a page, you can create an issue. Make sure to provide links to the relevant page, either the rendered version or the source file, along with an annotated screenshot. Providing detailed information helps us quickly identify and fix issues.

Feeedback

Join the Domino REST API conversation in the HCL Domino forum at the HCLSoftware Digital Solutions Community Forum, or connect with the community on the OpenNTF Discord channel.

Set up GitHub email notifications

Configure your email notification preferences to receive notifications.

1. Go to Notifications.

2. Make sure that your preferred email address is correctly set as the Default notification email.

3. Make sure that the following options are selected to receive email updates for conversations you are involved in or watching under Customize email updates:

   • Pull Request reviews
   • Pull Request pushes
   • Comments on Issues and Pull Requests

License

The documentation is available as open source under the terms of the Apache License 2.0.