wso2 / product-apim

Welcome to the WSO2 API Manager source code! For info on working with the WSO2 API Manager repository and contributing code, click the link below.
http://wso2.github.io/
Apache License 2.0
838 stars 783 forks source link

WSO2 APIM Carbon Management Portal User Guide unavailable #12571

Open Anupamskd7 opened 2 years ago

Anupamskd7 commented 2 years ago

Description:

The Claims section's Help (User Guide) page throws a 404-Not Found error. This Help button redirects to an internal html file (at https:///carbon/identity-claim-mgt/docs/userguide.html) which is unavailable in the image.

Steps to reproduce:

Affected Product Version:

WSO2 API Manager 3.2.0 Available at Docker hub with the following image-name:tag -> wso2/wso2am:3.2.0

Environment details:

vivekNEC commented 1 week ago

Hi @Anupamskd7 I checked the WSO2 Identity Server Carbon Console, and there is no Help option available in any of the sections, such as the Claim section, User Store section, or even on the Carbon home page. I am considering whether it’s necessary to add a user guide in each section of the WSO2 APIM Carbon Console, or if we should remove the Help button altogether. Please guide me if I am wrong, and also let me know where I can find the path (https://localhost:9443/carbon/identity-claim-mgt/docs/userguide.html) if it is required, so I can add this userguide.html page for every Help section.

vivekNEC commented 4 days ago

Hi @Anupamskd7

I have checked all sections in the Carbon console after login , but there is no available /docs/userguide.html page for help.

  1. Should we add a docs directory for all WSO2 GitHub repositories where the userguide.html page is needed for each section?

  2. Alternatively, can we provide a link to the user guide for each relevant section (e.g., "https://is.docs.wso2.com/en/6.0.0/guides/dialects/add-claim-dialects/")? This would include sections such as:

    • Users and Roles
    • User Stores
    • Claims
    • Service Providers
    • Identity Providers
    • OIDC Scopes
    • Keystores
    • Email Templates
    • Consent Purposes**
  3. If you want to add a userguide.html page for every specific section, where can I find the content for these pages?