[Docs Issue] "Set up Wso2 Identity Server as a federated Authenticator" lacks context/ links to certain steps
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
The steps in this process that lack the ease of use that the rest of the docs have. Especially with providing links to certain actions.
A few key improvements especially for new users to have a better experience could be :
-
Similar to how there is a link provided for GitHub releases provide an image or link to creating a port offset
-
Including the click update after every step so that they make sure they do it and not lose the configs. Include this at the end of step 6 and 7.
-
At step 7 maybe include a circle around "+ New Role" and also this UI so the users are not having to guess on their own if the assumptions are correct.
-
Similarly at step 8 it could be more descriptive by including the + New user -> Single User and we provide this UI with example values
-
This step is too vague, also includes a typo witht he word "assinging" instead word it like this: Select a role -> Go to the Users tab and assigning users to the role. amd include a screen shot.
- Small typo that can be addressed, change it to step 15. not 1. and make it devportal not developer role
- Step 2 under "Set Up WSO2 API Manager", there is 0 context with this screen shot, needs to atleast include a url or something showing it is the carbon console.
-
A pain point following the steps 7 to 12 is that this process takes a while and the user gets logged out and loses all that progress when configuring a identity server We need to include a note or something to the extent of, It is best practice to make a few changes to the configurations -> Click finish -> Then edit the Identity server configs, so that the user does not get timed out due to inactivity. (This was the process I used after loosing progress twice)
-
Finally the ending needs to include how the user can go ahead and use these changes. maybe something like open publisher protal, https://localhost:9443/admin -> Log in via admin portal user configured
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
Start with the linked “Set up WSO2 Identity Server as a federated Authenticator” page and compare steps 2, 6–8, 15, and the ending against the requested examples. Add the missing links, context, screenshots, save guidance, timeout note, usage instructions, and typo fixes; done means the full setup flow is unambiguous for a new user.
Written by the indexing model from the issue text.
Assessment
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100