-
Task
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
False
-
-
False
-
-
Task
As an engineer working on RHDH, I want to have real-time editing of TechDocs so that we can provide more documentation use cases that can replace existing other solutions for the product.
Background
During developer week, I was exploring possible solutions for real-time web editing of markdown TechDocs to address the common want from RHDH in order to adopt for documentation use.
During this investigation I found HedgeDoc, a service that can provide all that we're looking for to solve this missing piece. It does come with challenges for doing direct integration:
- No integration support, this means in order to integrate into RHDH we'll need to rewrite their source code to create plugins.
- Relies on its own authentication system, it can connect to the same authentication sources as RHDH (such as SAML, LDAP, GitHub, etc.) but cannot share the same login session (i.e. HedgeDoc using RHDH authentication component).
The alternative to integration is to couple them as separate services. The common dominator here is Minio storage. If we can storage the TechDocs in Minio and share the storage between RHDH and HedgeDoc we could achieve a solution that would provide more reason to use RHDH for documentation over other solutions.
Dependencies and Blockers
QE impacted work
Documentation impacted work
Acceptance Criteria
Create a POC that deminstrates that HedgeDoc and RHDH deployments can both use the same TechDocs via the Minio storage service
Using the POC, verify the changes that applied via the HedgeDoc deployment can be seen in the RHDH deployment