freeipa-webui icon indicating copy to clipboard operation
freeipa-webui copied to clipboard

[Doc] Implement developer guides for the new WebUI

Open carma12 opened this issue 2 years ago • 6 comments

In order to guide new contributors to the new WebUI, it is necessary to have developer guides that explain and document some aspects of the application (debugging, testing, implementation of new features, navigation, etc.).

E.g.: Similar to what is done in the current WebUI: https://github.com/freeipa/freeipa/tree/master/install/ui/doc/guides

This requires a good understanding of the project, identifying the key components and patterns needed in the implementation/testing/other aspects, and writing how-to guides providing the context needed.

carma12 avatar Aug 29 '23 10:08 carma12

This issue has not received any attention in 365 days.

github-actions[bot] avatar Aug 28 '24 12:08 github-actions[bot]

This issue has not received any attention in 365 days.

github-actions[bot] avatar Aug 28 '25 12:08 github-actions[bot]

@carma12 , @veronnicka with changes from Rafael and other changes coming in: https://github.com/freeipa/freeipa-webui/pull/843/commits/d3d56fc91da685a4a23a6f47b89ca5e23e821607 can we close this one?

duzda avatar Oct 02 '25 07:10 duzda

@duzda @veronnicka @rjeffman - Not necessarily... By development guides I meant "things that the potential contributors must known to understand the modern WebUI", things like how everything is structured in general within the project.

I would suggest to reuse Ab's idea on the Wiki page for the modern WebUI but refining some parts that need more detail (or fixing AI hallucinations). WDYT?

carma12 avatar Oct 02 '25 08:10 carma12

I agree with @carma12.

My suggestion is that the dev guides should still exist, with brief description and examples, and include the thinking behind plugin development (once we have it).

This structure seems to help both devs and AI agents (used by devs).

rjeffman avatar Oct 02 '25 15:10 rjeffman

Thanks for clarifying

duzda avatar Oct 03 '25 07:10 duzda