Skip to content

[Docs Issue] Standardize Terminology in Setup WSO2 Identity Server as a Federated Authenticator Documentation #9092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dakshithas opened this issue Mar 7, 2025 · 0 comments

Comments

@Dakshithas
Copy link

Dakshithas commented Mar 7, 2025

The documentation inconsistently refers to different UI elements using the same term "section", leading to confusion for users navigating the WSO2 Identity Server Console. Below are some problematic instances:

  1. Step 7:

    • "Under User Attributes section, select Roles."
    • Here, section actually refers to a tab, but the wording may cause users to look for a separate "User Attributes section" instead of the User Attributes tab.
  2. Step 8:

    • "Under Subject section, select Assign alternate subject identifier and select Username."
    • The term section is used to refer to a sub-section inside the Roles tab, leading users to mistakenly search for another tab under the Application settings instead of looking inside the User Attributes tab.
  3. Step 10:

    • "Go to the User Management section, navigate to the Users tab, and create three users—one for each portal."
    • Here, section refers to a menu item in the left navigation panel, which differs from its usage in previous steps.

Screenshots for Reference

1. "User Management section" actually refers to a menu item

User Management Menu

2. "User Attributes section" is actually a tab

Image

3. "Subject section" is a sub-section within the Roles tab

Image

Suggested Improvement

Suggested Enhancement

  • Clearly define and standardize the terminology used in documentation.
  • Use the following standardized terms:
    • Menu item → Top-level navigation (e.g., "User Management" in the sidebar).
    • Tab → A selectable option within a panel (e.g., "User Attributes" under Applications).
    • Sub-section → A nested category inside a tab (e.g., "Subject" inside the Roles tab).

Example of a Standardized Instruction Format

Instead of:

"Under User Attributes section, select Roles."

Use:

"Go to the User Attributes tab and select Roles."

Version

4.5.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant