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 blueprint library page #1313

Merged
merged 20 commits into from
Nov 23, 2023
Merged

Conversation

Yndira-E
Copy link
Contributor

Description

First iteration of the blueprint library page

Related Issue(s)

closes #1256

Checklist

  • I have read the contribution guidelines
  • I have considered the performance impact of these changes
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated

@Yndira-E Yndira-E linked an issue Nov 10, 2023 that may be closed by this pull request
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 39.6%, saving 354.46 KB.

Filename Before After Improvement Visual comparison
src/blueprints/manufacturing/images/ANDON-Screenshot.png 200.85 KB 109.74 KB -45.4% View diff
src/blueprints/manufacturing/images/dashboard-data.png 290.50 KB 193.32 KB -33.5% View diff
src/blueprints/manufacturing/images/dashboard-empty.png 254.50 KB 140.64 KB -44.7% View diff
src/blueprints/manufacturing/images/performance-dashboard.png 149.50 KB 97.19 KB -35.0% View diff

643 images did not require optimisation.

@Yndira-E
Copy link
Contributor Author

@MarianRaphael, this is the first iteration for the page.

It still needs some work, and the idea is to have it synced with https://github.com/FlowFuse/blueprint-library/tree/main.

For now, I've simply copied the files from that repository, but those markdown files don't match the proposed structure in the issue. I've also copied the flow.json files, although I'm not sure if you'll need them.

How many blueprints and categories do we expect to have? This will determine the structure of the library.

@Yndira-E Yndira-E force-pushed the 1256-flowfuse-blueprint-library-page branch from 2d145e0 to 262b174 Compare November 10, 2023 17:00
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 39.6%, saving 354.46 KB.

Filename Before After Improvement Visual comparison
src/blueprints/manufacturing/images/ANDON-Screenshot.png 200.85 KB 109.74 KB -45.4% View diff
src/blueprints/manufacturing/images/dashboard-data.png 290.50 KB 193.32 KB -33.5% View diff
src/blueprints/manufacturing/images/dashboard-empty.png 254.50 KB 140.64 KB -44.7% View diff
src/blueprints/manufacturing/images/performance-dashboard.png 149.50 KB 97.19 KB -35.0% View diff

645 images did not require optimisation.

@Yndira-E
Copy link
Contributor Author

BTW add /blueprints/ to the preview URL to view the page. Where should we place it in the menu?

@Yndira-E Yndira-E force-pushed the 1256-flowfuse-blueprint-library-page branch from 8215419 to 1051ad9 Compare November 13, 2023 15:25
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 39.6%, saving 354.46 KB.

Filename Before After Improvement Visual comparison
src/blueprints/manufacturing/images/ANDON-Screenshot.png 200.85 KB 109.74 KB -45.4% View diff
src/blueprints/manufacturing/images/dashboard-data.png 290.50 KB 193.32 KB -33.5% View diff
src/blueprints/manufacturing/images/dashboard-empty.png 254.50 KB 140.64 KB -44.7% View diff
src/blueprints/manufacturing/images/performance-dashboard.png 149.50 KB 97.19 KB -35.0% View diff

646 images did not require optimisation.

@ZJvandeWeg
Copy link
Member

ZJvandeWeg commented Nov 16, 2023

It still needs some work, and the idea is to have it synced with https://github.com/FlowFuse/blueprint-library/tree/main.

For now, I've simply copied the files from that repository, but those markdown files don't match the proposed structure in the issue. I've also copied the flow.json files, although I'm not sure if you'll need them.

How many blueprints and categories do we expect to have? This will determine the structure of the library.

@Yndira-FlowForge Can you look at how we copy the docs and achieve this PR like this? That's easier to manage for everyone.

@Yndira-E
Copy link
Contributor Author

Yndira-E commented Nov 18, 2023

@ZJvandeWeg Done! I've opened a PR in the blueprints repository too. Once merged, it should enable the desired rendering.

@Yndira-E Yndira-E force-pushed the 1256-flowfuse-blueprint-library-page branch from 33055b7 to b742b2e Compare November 18, 2023 14:54
@MarianRaphael
Copy link
Contributor

First iteration looks good! I need to improve the Readme representation for the website, but I like the concept and its sync with the blueprint repository.
Screenshot 2023-11-18 at 16 28 15

@Yndira-E Yndira-E force-pushed the 1256-flowfuse-blueprint-library-page branch from ca3291f to d56b5b3 Compare November 20, 2023 09:36
.gitignore Show resolved Hide resolved
@Yndira-E
Copy link
Contributor Author

Yndira-E commented Nov 20, 2023

Tests are failing, and I believe it's because the blueprints repository is private.

One solution involves creating a personal token (which I already did) and adding it as a secret in the website repository; but I don't have access to its settings. Additionally, if I'm understanding correctly, this would tie my gh user to the blueprints repository access, so that content would only be updated if I open the PR.

The other solution, could be this one. I consider this is a better option, because it would update regardless of who opens the PR, but I would need help with it, and I think it has to be an admin who creates/adds the app.

What do you think?

@Yndira-E Yndira-E force-pushed the 1256-flowfuse-blueprint-library-page branch from 70234f6 to 5194a13 Compare November 22, 2023 07:14
@Yndira-E Yndira-E marked this pull request as ready for review November 22, 2023 07:29
@Yndira-E
Copy link
Contributor Author

Yndira-E commented Nov 22, 2023

It's passing the tests now! 🎊

The first issue with the private repository was resolved by @ppawlowski (thank you!). Another issue was related to the path in the image key in the front matter; now, just the filename is enough, as long as it is in the same folder as the markdown file.

Since we don't have many blueprints per category, I removed the filter. We can consider adding it as part of a future iteration when we have more blueprints.

@MarianRaphael
Copy link
Contributor

PR looks good. I just have to rework all the blueprint READMEs to have better representation on our website. Additionally, not all blueprints in the repo are yet available in Flowfuse due to UI limitations that we will fix next week.

@MarianRaphael
Copy link
Contributor

I'll push the 'not yet available' ones to a different branch and start reworking the three crucial ones, to merge as soon as possible

Copy link
Contributor

@MarianRaphael MarianRaphael left a comment

Choose a reason for hiding this comment

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

@Yndira-FlowForge good to go from my side. In the main blueprint branch, there are now just the three available blueprints.

@Yndira-E Yndira-E force-pushed the 1256-flowfuse-blueprint-library-page branch from 219a332 to 854553b Compare November 23, 2023 09:22
@Yndira-E Yndira-E merged commit 3efd9d0 into main Nov 23, 2023
4 checks passed
@Yndira-E Yndira-E deleted the 1256-flowfuse-blueprint-library-page branch November 23, 2023 09:59
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.

FlowFuse Blueprint Library - Page
4 participants