dotCMS / dotCMS/core

Users portlet: user documentation and release notes

Open
#36,721 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dotCMS : Admin Tools Team : Modernization Type : Documentation
Dominant language
Java
Stars
970
Forks
486
Avg merge
3d 33m
Merged PRs (30d)
170

Description

Goal

Publish user-facing documentation and release notes for the Users portlet Beta once implementation is complete.

Deliverables

  • User-facing docs page (or update to existing Users docs) covering the list, dialog tabs, and how to opt into the Beta from "Add Portlet" in Tools
  • Release notes entry
  • Screenshots of the final shipped UI

Acceptance criteria

  • Docs page published and linked from the release notes
  • Screenshots reflect the shipped UI
  • Any known limitations documented (e.g. Permissions tab iframe)

Design references

Interactive prototype (design intent): https://claude.ai/design/p/324a0e09-34dc-4925-a7fa-24f39fdafa54?via=share&file=Users.html

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Users documentation and release-notes structure, then inspect the final shipped Users portlet from Add Portlet in Tools. Use the shipped UI to document the list, dialog tabs, Beta opt-in, screenshots, and known limitations such as the Permissions tab iframe; link the docs page from the release notes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.