Skip to main content

How to obtain help for doxygen2docusaurus

The most efficient approach is to utilise the GitHub Discussions pages.

Web page issues​

If you encounter any issues within the content of these pages (such as typographical errors or incorrect phrasing) or have suggestions for improving the documentation, please share them through the GitHub Discussions pages. Ensure you provide the full URL of the page, clearly identify the section with the problematic content, and suggest improvements.

Check documentation​

As usual, before asking anything, it is advisable to review the project documentation.

The project documentation is currently available exclusively on the project website. The project documentation is currently available exclusively on the project's website.

Preliminary checks​

Before posting any questions or providing feedback, verify whether the subject has not already been addressed.

Ask questions in GitHub Discussions​

If you still cannot find a solution, have interesting use cases, custom configurations, or any experiences you wish to share with others, please utilise the GitHub Discussions pages. Initiate a New discussion; utilise the Q&A category for questions, Ideas for suggestions and General for everything else.

Register a new support ticket only if necessary​

If you are convinced that you have identified a bug or wish to contribute code to enhance the Doxygen Documentation Converter project, register a New Issue in the GitHub Issues tracker.

caution

Please do not utilise the GitHub Issues tracker for questions and support; instead, utilise the GitHub Discussions pages.

Stack Overflow​

For community assistance, you may also utilise Stack Overflow. Tag your questions with xpack.

tip

Please be aware that there is another tag elastic-x-pack for a different project, and some of their questions are tagged with xpack as well.

The Discord channel​

For live discussions amongst members, join the xPack Community on Discord.

Currently, there are several channels available:

  • #xpm
  • #xcdl
  • #xpack-dev-tools
  • #general

These channels are open for free discussions on their respective topics.

However, for support, please utilise GitHub Discussions whenever possible.

X/Twitter​

New releases and other announcements are posted on X/Twitter.

Follow the hashtag #xpack_project for the latest updates.

Use of private email​

Please, please, please!

Do not utilise private email for support; instead, utilise the GitHub Discussions pages.

Private messages will receive an automated reply containing a link to this page. This approach is not intended to be discourteous, but rather to optimise time efficiency; as discussions are archived, others facing similar issues may benefit from the provided answers.