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.

Sign up for GitHub

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

Jump to bottom

Make clientAPI label distinguishable #3920

Merged
merged 8 commits into from
Sep 30, 2024
Merged

Make clientAPI label distinguishable #3920

merged 8 commits into from
Sep 30, 2024

Conversation

ndricimrr
Copy link
Contributor

@ndricimrr ndricimrr commented Sep 18, 2024 •
edited
Loading

Description

Changes proposed in this pull request:
This PR adds a tooltip (title) to the labels that are added on the luigi client api documentation to give more clarification to the labels and avoid confusions

  1. Web App API only --> This should represent all Luigi Client API functions (Classic ones) which you cant find for Luigi Container and WC-based Microfrontends in general. Please add suggestions if the phrasing is not right .
Screenshot 2024-09-18 at 18 53 41
  1. Web Component API ONLY : --> This is aimed at all the LugiClient API functions that you would only find on Luigi Container clientAPI or WC-based microfrontends in general . Please add suggestions if the phrasing is not right .

(it would look like this when #3882 is merged.)
Screenshot 2024-09-17 at 15 16 23

Related issue(s)

Fixes #3903

@ndricimrr ndricimrr added the documentation documentation tasks label Sep 18, 2024
@ndricimrr ndricimrr changed the title Add changes Make clientAPI label distinguishable Sep 18, 2024
@ndricimrr ndricimrr marked this pull request as ready for review September 18, 2024 16:58
@JohannesDoberer JohannesDoberer self-assigned this Sep 19, 2024
JohannesDoberer
JohannesDoberer reviewed Sep 23, 2024
View reviewed changes
Copy link
Contributor

@JohannesDoberer JohannesDoberer left a comment

Choose a reason for hiding this comment

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

Small comment.
Should we mark storageManager as well? As I can see it is not available for wc api.

website/docs/src/app.html Outdated Show resolved Hide resolved
@ndricimrr
Copy link
Contributor Author

@JohannesDoberer Added the changes

JohannesDoberer
JohannesDoberer approved these changes Sep 25, 2024
View reviewed changes
Copy link
Contributor

@JohannesDoberer JohannesDoberer left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ndricimrr ndricimrr merged commit f0956a2 into main Sep 30, 2024
11 checks passed
@ndricimrr ndricimrr deleted the 3916-distinguish-label-3903 branch September 30, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JohannesDoberer JohannesDoberer JohannesDoberer approved these changes

@hardl hardl Awaiting requested review from hardl hardl is a code owner

@VincentUllal VincentUllal Awaiting requested review from VincentUllal VincentUllal is a code owner

@smahati smahati Awaiting requested review from smahati smahati is a code owner

@walmazacn walmazacn Awaiting requested review from walmazacn walmazacn is a code owner

@amilewskaa amilewskaa Awaiting requested review from amilewskaa amilewskaa is a code owner

Assignees

@JohannesDoberer JohannesDoberer

Labels
documentation documentation tasks
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make Web Component API documentation label distinguishable
2 participants
@ndricimrr @JohannesDoberer