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(dynamic-plugins): add frontend docs #716

Merged
merged 5 commits into from
Nov 7, 2023

Conversation

tumido
Copy link
Member

@tumido tumido commented Nov 6, 2023

Description

Documentation to #700

Which issue(s) does this PR fix

Part of #442

PR acceptance criteria

Please make sure that the following steps are complete:

  • GitHub Actions are completed and successful
  • Unit Tests are updated and passing
  • E2E Tests are updated and passing
  • Documentation is updated if necessary (requirement for new features)
  • Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

@tumido tumido requested a review from a team as a code owner November 6, 2023 10:29
Copy link

changeset-bot bot commented Nov 6, 2023

⚠️ No Changeset found

Latest commit: ffb0538

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@tumido tumido force-pushed the dynamic-frontent-docs branch 5 times, most recently from 5d0dd88 to addd8a8 Compare November 6, 2023 13:03
Signed-off-by: Tomas Coufal <tcoufal@redhat.com>
Copy link
Member

@davidfestal davidfestal left a comment

Choose a reason for hiding this comment

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

Approved with 1 question and 1 suggestion

showcase-docs/dynamic-plugins.md Outdated Show resolved Hide resolved
module: CustomModule # optional, same as key in `scalprum.exposedModules` key in plugin's `package.json`
importName: FooPluginPage # optional, actual component name that should be rendered
menuItem: # optional, allows you to populate main sidebar navigation
icon: Storage # MUI4 icon to render in the sidebar
Copy link
Member

Choose a reason for hiding this comment

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

Is there the ability to use a provided icon (not MUI-standard) ?

Co-authored-by: David Festal <dfestal@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
@tumido tumido requested a review from nickboldt November 6, 2023 17:07
Copy link
Member

@nickboldt nickboldt left a comment

Choose a reason for hiding this comment

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

skimmed and did some language review; looks OK to me.

probably more language tweaks could be done but until @hmanwani-rh can get 👀 on it, I think it's probably OK to merge as is and be cleaned up later if/when we're downstreaming this into one of the RHDH user / admin guides

@nickboldt
Copy link
Member

/test

Copy link

sonarcloud bot commented Nov 7, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
4.8% 4.8% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@kadel kadel merged commit 47d52ff into janus-idp:main Nov 7, 2023
2 of 3 checks passed
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.

None yet

4 participants