wso2 / wso2/docs-apim

Confusing steps in Using Email Address as the Username

Open
#3,314 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-3.2.0 API-M-4.0.0 Docs/TW Type/Improvement
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
In Using Email Address as the Username section the steps have been linked to IS doc, when user navigates to steps and the first step is as follows,

  1. Open the <IS_HOME>/repository/conf/deployment.toml file.

The above step is confusing as the user may not have an IS_HOME directory.
Screen Shot 2021-03-17 at 12 10 32 PM
Screen Shot 2021-03-17 at 12 09 48 PM

https://is.docs.wso2.com/en/5.10.0/learn/using-email-address-as-the-username/

We can add the 5 steps in our doc rather than linking to the IS doc.

Suggested Labels:
API-M 4.0.0

Affected Product Version:
API-M 4.0.0

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Using Email Address as the Username page at the linked IS documentation URL and review the current linked steps, especially the <IS_HOME>/repository/conf/deployment.toml instruction. Replace the external link with the five steps in this documentation, making the path guidance clear; the page should no longer send users to confusing instructions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.