[MI Dashboard] Multiple Issues in Running the Dashboard Doc
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description:
Doc in question: https://apim.docs.wso2.com/en/latest/install-and-setup/install/installing-the-product/running-the-mi-dashboard
- Links to download and install MI and MI dashboard should open in new tabs. Otherwise, the reader will be lost in a different place in docs, and the flow breaks.
- In step 2, Set up the Micro Integrator section, the toml configurations of
heartbeat_interval,group_idandnode_idare optional. It's confusing for a reader who's just looking to run the dashboard to see these multiple configurations in the first run. We should only add the mandatory configs and have a link to all other available configurations. - Start the Micro Integrator link should open in a new tab.
- Having the Configuring Single Sign-on with OpenID Connect section before the Starting the dashboard server is very confusing. We should understand that the primary goal of a reader who comes to this page is to run the dashboard. Also, we should describe briefly what SSO means and how it works with the dashboard, before saying to add a toml config. IMO, SSO should be an entirely different doc.
- The link, https://localhost:9743/dashboard given in the Accessing the dashboard section doesn't work. It should be just https://localhost:9743 or https://localhost:9743/login
Affected Product Version:
4.2.0
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Running the MI Dashboard page and review its links, setup steps, SSO section, and dashboard URL. Update the page so installation and startup links open in new tabs, only mandatory TOML settings appear in the initial setup, the dashboard flow comes before SSO, and the access URL works. Verify the revised page and links against the Micro Integrator documentation.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100