EPIC Goal

Rethink, discuss and document (as techdocs) our best practices, tips & tricks for the UI development.

Initial audience: New (onboarding guide) and existing team members (reference work)

Topics might include code samples, commonly used libraries, recommended props, and debug and test tips and tricks.

It should include information how to write and test a new frontend plugin.

It should include tips on running a dynamic plugin locally (in your backstage app), in the RHDH app (showcase it as a dynamic plugin!), and on a cluster.

How to write and run e2e tests against these different instances. (Local, showcase, cluster)

How do you debug an instance locally and remotely?

Non goals

It should not include detailed information on how dynamic plugins are working or build. This will definitely be part of the dynamic plugin documentation.

Why is this important?

This is part of continuous learning and self-improvement (as a team).

Sharing information is important for new members and reduce single point of failures.

Dependencies (internal and external)

None

Acceptance Criteria

We have some UI team documentation at https://github.com/redhat-developer/rhdh-team-docs that answers questions like:

1. Best practices for a new plugin, recommended libraries
2. How to write and run E2E tests running locally (in plugins-repo or a BCP workspace, in the showcase as a dynamic-plugin) or on a cluster
3. What are the differences / what could go wrong between locally and a cluster
4. How to debug locally or on a cluster?
5. Some notes on specific features like RBAC? Or should this go into a rbac plugin techdocs???
6. Additional, but very well structured links
7. FAQ / Common issues
8. Migrating some Google Docs??? Which one???