Visit the published site at https://opensource.hcltechsw.com/digital-experience
View the documentation for product features and usage information.
You are welcome to report bugs or provide feedback on the product documentation via pull requests on GitHub at https://github.com/HCL-TECH-SOFTWARE/digital-experience. This is the Digital Experience product documentation website and not the product support platform, all bug reports and pull requests shall pertain to product documentation. You are expected to update only the markdown files in the docs directory.
Perform the following steps to install mkdocs and clone the git repository to update the markdown files.
- Follow the MkDocs Installation guide to install
MkDocsandpip - Install the required
mkdocsplugins:pip install -r requirements.txt
- Clone the dx-compose-doc repository
- Update the markdown files in the
docsfolder - Verify the changes by building the project locally mkdocs serve
- Commit the changes
- Create and submit a Pull Request
- Await the PR to be reviewed, merged, and built
Configure your email notification preferences to receive notifications.
- Go to Notifications
- Under Email notification preferences, ensure you have a valid email address in the Default notification email box
- Ensure that the following three options are selected to receive updates on conversations that you’re participating in or watching:
- Comments on Issues and Pull Requests
- Pull Request reviews
- Pull Request pushes
The documentation is available as open source under the terms of the Apache License 2.0.