-
Task
-
Resolution: Duplicate
-
Normal
-
None
-
RHDH Documentation 3269, RHDH Documentation 3270, RHDH Documentation 3271, RHDH Documentation 3272
This is follow up to https://issues.redhat.com/browse/RHIDP-3966
Feature Overview (aka. Goal Summary)
Create comprehensive Dynamic Plugins Documentation for Red Hat Developer Hub (RHDH) to streamline plugin development process and improve developer experience
Goals (aka. expected user outcomes)
- Developers can easily bootstrap, debug, test, and deploy plugins for RHDH
- Reduced learning curve for plugin development in RHDH ecosystem
- Improved consistency and quality of plugins developed for RHDH
- Enhanced developer productivity through clear guidance and best practices
- Requirements (aka. Acceptance Criteria):
- Provide step-by-step guide for bootstrapping a plugin
- Include instructions for setting up development environment aligned with RHDH release
- Detail local debugging processes (VScode) for isolated plugin development
- Detail local debugging processes (VScode) within RHDH context (plugin loaded)
- Outline best practices for unit testing, integration testing, and e2e testing
- Document process for building, publishing, and consuming containerized plugins
- Deliver documentation as TechDocs
- Create FAQ and best practices section with links to example code
- This should be use-case oriented, e.g. how to mount a plugin
- Develop CLI improvements for creating environment/dependencies for specific RHDH releases
Out of Scope (Optional)
- Detailed explanations of upstream Backstage concepts
- In-depth tutorials on general web development practices
- Support for non-RHDH plugin development
- Customer Considerations (Optional)
- Ensure documentation is accessible to developers with varying levels of experience
- Consider potential differences in development environments across customer organizations
- Address common pain points in plugin development process based on customer feedback
Documentation Considerations
- Use clear, concise language suitable for technical audience
- Include visual aids (diagrams, screenshots) where appropriate
- Provide links to relevant upstream documentation for additional context
- Avoid embedding too much code snippets into the documentation, rather link to existing code
- duplicates
-
RHIDP-5138 [Docs] Plugins content improvements
-
- In Progress
-
There are no Sub-Tasks for this issue.