isabella232 / digital-experience

Next-generation documentation site for HCL Digital Experience.

HCL Digital Experience Help Center

Visit the published site at https://opensource.hcltechsw.com/digital-experience

Usage

View the documentation for product features and usage information.

Contributing

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.

How to contribute?

Perform the following steps to install mkdocs and clone the git repository to update the markdown files.

• Follow the MkDocs Installation guide to install MkDocs and pip
• Install the following mkdocs plugins:
  • pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-git-revision-date-localized-plugin
• Clone the digital-experience repository
• Update the markdown files in the docs folder
• 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

Set up github email notification

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 you’re participating in or watching
  • Comments on Issues and Pull Requests
  • Pull Request reviews
  • Pull Request pushes

License

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