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

Add documentation on the steps to create a compiler plugin #9514 #9524

Closed

Conversation

rajasurya-rjs
Copy link

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

  • Page addition
    Add permalink to pages.
    Ensure each new page has a unique permalink to maintain proper routing and SEO.
  • Page removal
    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.

  • Page rename
    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.

  • Page restructure
    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.

@CLAassistant
Copy link

CLAassistant commented Oct 2, 2024

CLA assistant check
All committers have signed the CLA.

@sm1990 sm1990 requested a review from gimantha October 3, 2024 04:35
@gimantha
Copy link
Contributor

gimantha commented Oct 3, 2024

@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
Please refer to https://medium.com/ballerina-techblog/module-import-restriction-with-ballerina-code-analyzers-5e21d9644985

@gimantha gimantha closed this Oct 4, 2024
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.

Add documentation on how to create a compiler plugin
3 participants