-
Notifications
You must be signed in to change notification settings - Fork 169
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
Improve the EDI tool learn page #8239
Improve the EDI tool learn page #8239
Conversation
Co-authored-by: Anupama Pathirage <anupama@wso2.com>
| `EDI schema path` | Path of the EDI schema which will be used to generate the code. | Mandatory | | ||
| `output path` | The path in which the output file will be created. | Mandatory | | ||
| `<edi-schema-path>` | Path of the EDI schema, which will be used to generate the code. | Mandatory | | ||
| `<output-path>` | The path in which the output file will be created. | Mandatory | | ||
|
||
### Package generation command options | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to have command options
part in sub heading too as it is there in main heading?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we have the code generation
and package generation
subheadings repeated under many main headings such as Usage
, Command options
, and Examples
, it is clearer to repeat those in the sub headings as follows.
Usage
- Code generation usage
- Package generation usage
Command options
- Code generation command options
- Package generation command options
Examples
- Code generation example
- Package generation example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, if we remove the repetition of the words, the URLs of the subheadings will be generated as follows as there will be multiple similar ones.
- /learn/edi-tool/#code-generation-1
- /learn/edi-tool/#code-generation-2
- /learn/edi-tool/#code-generation-3
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, a better structure would be to have 2 main sections for code and package generation as follows similar to [1].
Code generation
- Code generation usage
- Code generation command options
- Code generation example
Package generation
- Package generation usage
- Package generation command options
- Package generation example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, we definitely need to fix the structure, as suggested in the last comment above.
Purpose
Improve the EDI tool learn page.
Checklist
Page addition
permalink
to pages.Page removal
redirect_from
on the alternative page.redirections.js
file.Page rename
redirect_from
.redirect_to:
(if applicable).Page restrcuture
permalink
to pages.redirect_from
.redirect_to:
(if applicable).