Add documentation on the steps to create a compiler plugin #9514 #9524
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rajasurya-rjs
requested review from
MaryamZi,
sm1990 and
keizer619
as code owners
|
|
|
@rajasurya-rjs did you create a compiler plugin for Ballerina as instructed in your pull request? Please re-check what you have worked on. This is not how you would implement a compiler plugin for Ballerina |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The purpose of this document is to outline the necessary steps and actions required for managing changes to the documentation pages, ensuring that any additions, removals, or modifications maintain the integrity and accessibility of the documentation.
Fixes #9514
Checklist
Add permalink to pages.
Ensure each new page has a unique permalink to maintain proper routing and SEO.
Remove entry from corresponding left nav YAML file.
Locate the appropriate navigation file and delete the entry for the page being removed.
Add redirect_from on the alternative page.
If an alternative page exists, add the redirect_from front matter to the old page, pointing users to the new location.
If no alternative page, add redirection on the redirections.js file.
Update the redirections.js file to create a 301 redirect to a relevant section or the home page if no alternative page exists.
Add front-matter redirect_from.
In the old page, add the redirect_from front matter to ensure users and search engines are redirected to the new page.
Add front-matter redirect_to: (if applicable).
In the new page, include the redirect_to: front matter if the renaming is part of a larger restructuring or if applicable for linking purposes.
Add permalink to pages.
For any restructured pages, ensure that each one has a unique permalink.
Add front-matter redirect_from.
For pages that are moved or restructured, add the redirect_from front matter to the original page.
Add front-matter redirect_to: (if applicable).
In the new location or structure, add redirect_to: if it aids navigation from the old page to the new structure.
Additional Notes
After making changes, test all links and redirections to ensure that they function correctly.
Update any related documentation or resources that may reference the changed pages.
Communicate changes with the team or stakeholders to keep everyone informed about updates.