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

chore: add plugin documentation #3636

Merged
merged 6 commits into from
Jun 25, 2024
Merged

Conversation

eirikhaugstulen
Copy link
Contributor

This PR adds the plugin developer documentation. This documentation will be hosted on the developers portal.

@eirikhaugstulen
Copy link
Contributor Author

PR in the developers portal: dhis2/developer-portal#152

@eirikhaugstulen eirikhaugstulen marked this pull request as ready for review May 10, 2024 07:20
@eirikhaugstulen eirikhaugstulen requested review from a team as code owners May 10, 2024 07:20
Copy link
Contributor

@simonadomnisoru simonadomnisoru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey,
In the Github preview for the newly added files there are some syntaxes that are not displayed correctly (warnings, tips, images, etc.). I suggested some alternatives using regular markdown syntax, but I'm not sure if this is a cause for concern or if it will compile and display correctly in the developer portal.
Thanks!

docs/developer/getting-started.md Outdated Show resolved Hide resolved
docs/developer/getting-started.md Show resolved Hide resolved
docs/developer/enrollment-plugins.mdx Outdated Show resolved Hide resolved
@eirikhaugstulen
Copy link
Contributor Author

Hey again! Thanks for the review @simonadomnisoru.

I actually ended up rewriting most of the documentation as it was not great. I'm aware that the preview functionality in GitHub does not really deal with mdx and docusaurus syntax very well, but you can inspect the final result here:
https://deploy-preview-152--dhis2-developer-portal.netlify.app/docs/capture-plugins/developer/getting-started

It does seem to be parsed and displayed correctly here! Please have a look and get back to me 👍

@simonadomnisoru
Copy link
Contributor

Hey again! Thanks for the review @simonadomnisoru.

I actually ended up rewriting most of the documentation as it was not great. I'm aware that the preview functionality in GitHub does not really deal with mdx and docusaurus syntax very well, but you can inspect the final result here: https://deploy-preview-152--dhis2-developer-portal.netlify.app/docs/capture-plugins/developer/getting-started

It does seem to be parsed and displayed correctly here! Please have a look and get back to me 👍

The final result on the developers portal looks great! Good job 👏

@eirikhaugstulen eirikhaugstulen merged commit d662688 into master Jun 25, 2024
23 of 24 checks passed
@eirikhaugstulen eirikhaugstulen deleted the eh/docs/plugin-documentation branch June 25, 2024 13:39
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 100.69.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

None yet

3 participants