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

docs: migrating demos to embed instead #1568

Merged
merged 18 commits into from
Sep 10, 2024
Merged

docs: migrating demos to embed instead #1568

merged 18 commits into from
Sep 10, 2024

Conversation

Topener
Copy link
Contributor

@Topener Topener commented Aug 5, 2024

This is a big revamp of the documentation to remove UI library dependency on the docs itself. This is to prepare the docs being merged into the developer portal.

The buttons on the demo component are still pending review from @cooper-joe so he's added as a reviewer here too.

Jira ticket: https://dhis2.atlassian.net/browse/LIBS-666

@dhis2-bot
Copy link
Contributor

dhis2-bot commented Aug 5, 2024

🚀 Deployed on https://pr-1568--dhis2-ui.netlify.app

@dhis2-bot dhis2-bot temporarily deployed to netlify August 5, 2024 12:56 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify August 5, 2024 13:15 Inactive
@Topener Topener added the documentation Improvements or additions to documentation label Aug 5, 2024
@dhis2-bot dhis2-bot temporarily deployed to netlify August 7, 2024 09:22 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify August 7, 2024 10:49 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify August 7, 2024 10:58 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 8, 2024 22:12 Inactive
@Topener Topener changed the title [WIP] docs: migrating demos to embed instead docs: migrating demos to embed instead Sep 9, 2024
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 08:35 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 08:44 Inactive
@Topener Topener marked this pull request as ready for review September 9, 2024 09:12
@Topener Topener requested a review from a team as a code owner September 9, 2024 09:12
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 09:26 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 09:33 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 10:23 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 10:31 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 11:16 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 12:18 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 12:28 Inactive
@Topener Topener requested a review from a team September 9, 2024 12:54
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 13:02 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 14:48 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 9, 2024 14:59 Inactive
Copy link
Collaborator

@kabaros kabaros left a comment

Choose a reason for hiding this comment

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

💯 approved .. just the two comments we discussed on Slack (for future improvements):

  • I think the Reload button doesn't add a lot of value, but as you said you intend to add more interactive demos and then it might be useful for it to reset state (I would all it "Reset" though, or just have a reload icon or something more subtle)

  • I think the two buttons (reload + show full demo) can be designed a bit more inline with the rest of the page .. they feel a bit jarring for me (@cooper-joe might have better input here though)

Finally, I think we can remove the demo links next. They're redundant now as we have links in all the embedded stories

Copy link
Member

@cooper-joe cooper-joe left a comment

Choose a reason for hiding this comment

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

A few suggestions for the button styling.

Agreed with @kabaros about renaming Reload to Reset demo. I also think it might be worth omitting this button for now until we have the interactive functionality in place.

docs/src/components/DemoComponent.module.css Outdated Show resolved Hide resolved
docs/src/components/DemoComponent.module.css Outdated Show resolved Hide resolved
docs/src/components/DemoComponent.module.css Outdated Show resolved Hide resolved
docs/src/components/DemoComponent.jsx Outdated Show resolved Hide resolved
@dhis2-bot dhis2-bot temporarily deployed to netlify September 10, 2024 10:03 Inactive
@dhis2-bot dhis2-bot temporarily deployed to netlify September 10, 2024 10:27 Inactive
@Topener
Copy link
Contributor Author

Topener commented Sep 10, 2024

@cooper-joe @kabaros there are already some demo's that do allow altering (such as the alert bar) which makes the reloading of the demo important. I could make it optional and only show it when it allows for it, but I guess that's an improvement we can handle later.

@kabaros kabaros enabled auto-merge (squash) September 10, 2024 12:04
@kabaros kabaros merged commit cf444b2 into master Sep 10, 2024
16 checks passed
@kabaros kabaros deleted the embed-demo branch September 10, 2024 12:36
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 9.11.4 🎉

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
Labels
documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants