Documentation Improvements – WSO2 Registry Web Portal & CLI Docs

Documentation Review Feedback – WSO2 Registry Web Portal, CLI & FAQ

This issue consolidates documentation feedback identified during a review of the WSO2 Registry documentation (container/image registry web portal & related tools).

The feedback focuses on:

• Improving clarity
• Aligning screenshots with actual user roles (admin vs. non-admin/customer)
• Addressing minor security concerns and wording improvements

---

Affected Documentation Pages

• en/docs/updates/wso2-registry-web-portal.md
• en/docs/updates/wso2-registry-cli-access.md
• en/docs/updates/wso2-registry-faq.md

---

Identified Improvements

1. Project Dashboard – Private Repository / Project Count

Problem In the project dashboard view, the count of private repositories or projects is shown as 0 for all projects. This may appear misleading to users.

Suggestion - Display the actual count of private repositories/projects if the data is available in the backend.

• If the count is genuinely not applicable, either hide the field or add a tooltip explaining why the value is shown as 0 (e.g., "Private repository count is not tracked for personal accounts").

---

2. Repositories View – Admin-only Information

Problem In the Repositories list, fields such as Quota Used, Access Level, and the Delete action are visible in the documentation screenshots. These appear to be admin-only features.

Suggestion - Confirm whether these are restricted to admin users.

• If they are admin-only, replace the screenshot with a non-admin view or add a clear caption:

  Note: This screenshot shows the view for organization administrators. Regular users see a simplified list without quota information or delete actions.

---

3. Tag Management – Admin vs Non-admin Actions

Problem The documentation screenshots show Add Tag and Delete Tag actions in the Tags view.

Suggestion - If these actions are not available to non-admin users, update the screenshots to reflect the customer view or add an explicit note:

Note: Tag management actions (Add/Delete) are available only to organization administrators. Regular users can view tags but cannot modify them.

---

4. Logs Section – Scope Clarification

Problem The documentation references a Logs section, but it is unclear what events are recorded or who can access them.

Suggestion Add clarification in the documentation:

The Logs section displays audit events related to your organization's registry usage, such as:

• Image/container push and pull events
• Tag updates
• Access denials

Access to the Logs section is restricted to organization administrators.

---

5. CLI Login Command – Security Awareness

Problem The CLI documentation suggests logging in using the -p flag, which stores credentials in shell history files in plaintext.

Suggestion Add a security note immediately after the command:

Security Note: Running docker login with -p stores your token in your shell history (e.g., ~/.bash_history). Use --password-stdin to avoid this:

echo "<Your_Token_Secret>" | docker login registry.wso2.com -u <Your_Token_Name> --password-stdin

---

6. FAQ – Token Revocation Wording

Problem The FAQ question regarding removing access for an old server or employee is too narrow.

Suggestion Rephrase to be more inclusive:
Q: How do I revoke access for a token (e.g., old server, former employee, or lost/stolen token)? A: Go to the token management section, select the token, and click Revoke / Delete. Revoking a token immediately prevents further authentication.

---

Expected Outcome

• Documentation accurately reflects admin vs non-admin user experiences.
• Screenshots align with the actual customer-visible UI.
• Improved clarity around logs, permissions, and feature availability.
• Better security guidance in the CLI section.

Related PR#181