Skip to content
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

Merged
merged 16 commits into from
Dec 4, 2023

Conversation

praneesha
Copy link

Purpose

Improve the EDI tool learn page.

Fixes #

Checklist

  • Page addition

    • Add permalink to pages.
  • Page removal

    • Remove entry from corresponding left nav YAML file.
    • Add redirect_from on the alternative page.
    • If no alternative page, add redirection on the redirections.js file.
  • Page rename

    • Add front-matter redirect_from.
    • Add front-matter redirect_to: (if applicable).
  • Page restrcuture

    • Add permalink to pages.
    • Add front-matter redirect_from.
    • Add front-matter redirect_to: (if applicable).

@praneesha praneesha self-assigned this Nov 13, 2023
@praneesha praneesha merged commit cfc67a2 into ballerina-platform:master Dec 4, 2023
1 check passed
@praneesha praneesha deleted the update-edi-tools branch December 4, 2023 12:03
| `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

Copy link
Contributor

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?

Copy link
Author

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

Copy link
Author

@praneesha praneesha Dec 4, 2023

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

Copy link
Author

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

[1] https://ballerina.io/learn/graphql-tool/

Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants