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

[MeshMap] Meshery Design Embedding: Create React Package and Publish NPM package #5175

Open
leecalcote opened this issue Dec 1, 2023 · 7 comments
Labels
framework/gatsby Gatsby related framework/react React related kind/enhancement New feature or request language/css language/javascript Issues or pull requests that use Javascript or React project/kanvas

Comments

@leecalcote
Copy link
Member

leecalcote commented Dec 1, 2023

Current Behavior

MeshMap users can export and embed designs in web pages - https://docs.layer5.io/meshmap/designer/export-designs/#exporting-as-embedding

Desired Behavior

Enhance MeshMap's ability to export and embed designs into web pages by creating a React package that is friendly to frameworks like Gatsbyjs, Nextjs, as well as generic React.

We recently released a new feature in meshmap that allows the designs to be downloaded as a js file we can be used to embed the design into websites
this works fine with static html sites but for gatsby and other react based frameworks it is still possible to get it going by dynamically loading the script
but that is a bit of too much to ask users to do
so we are going to create a new react package that will be small component that will just do this dynamic loading of the script for us
this package will be then used by user to embed the designs

Implementation

  1. React Component package
  2. GitHub workflow for publishing NPM package

Acceptance Tests

Mockups

See https://docs.layer5.io/meshmap/designer/export-designs/#exporting-as-embedding


Contributor Resources and Handbook

The layer5.io website uses Gatsby, React, and GitHub Pages. Site content is found under the master branch.

Join the Layer5 Community by submitting your community member form.

@leecalcote leecalcote added kind/enhancement New feature or request language/javascript Issues or pull requests that use Javascript or React framework/gatsby Gatsby related framework/react React related language/css project/kanvas labels Dec 1, 2023
@leecalcote
Copy link
Member Author

@aabidsofi19 FYI

@anshitmishra
Copy link
Contributor

hey @leecalcote i would love to take this work

@leecalcote
Copy link
Member Author

@anshitmishra, excellent!

@leecalcote
Copy link
Member Author

@iArchitSharma @aabidsofi19, we overlooked updating this issue with the work that has been completed thus far.

How might @anshitmishra engage on this one? Or do we need to help Anshit find another item?

@leecalcote
Copy link
Member Author

@iArchitSharma
Copy link
Contributor

iArchitSharma commented Jan 10, 2024

@anshitmishra Here is the docs on - https://docs.layer5.io/meshmap/designer/export-designs/embedding-designs/
There is an open issue on MeshMap - Display embed support form with help button inside meshmap troubleshoot guide
Basically we need a Help button in MeshMap that references this page

Can you help us by taking on this issue?

@anshitmishra
Copy link
Contributor

anshitmishra commented Jan 11, 2024

yes i would love to take this issue @iArchitSharma

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework/gatsby Gatsby related framework/react React related kind/enhancement New feature or request language/css language/javascript Issues or pull requests that use Javascript or React project/kanvas
Development

No branches or pull requests

4 participants