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

feat: jira plugin page #4627

Merged
merged 4 commits into from
Sep 7, 2023
Merged

feat: jira plugin page #4627

merged 4 commits into from
Sep 7, 2023

Conversation

sjaanus
Copy link
Contributor

@sjaanus sjaanus commented Sep 7, 2023

image

image

@vercel
Copy link

vercel bot commented Sep 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 7, 2023 8:38am
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 7, 2023 8:38am

@@ -337,6 +338,14 @@ export const routes: IRoute[] = [
type: 'protected',
menu: {},
},
{
path: '/integrations/view/:providerId',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently this serves only static page on Jira, but if more pages come, there might be possibility to make it generic.

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

No blockers, happy for you to merge this if it gives you more momentum 😄 However, I do have a few points that I think should be addressed either before merging or in a follow-up. Musings on whether variables will be present are completely optional and just thoughts I have. But the points on valid HTML structure and accessibility I think should be taken into account and fixed.

Happy to take any questions or hear thoughts ☺️

Comment on lines 33 to 39
return (
<StyledContainer>
<StyledTitle>{title}</StyledTitle>
<Typography>{description}</Typography>
<StyledImg src={formatAssetPath(src)} />
</StyledContainer>
);
Copy link
Contributor

Choose a reason for hiding this comment

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

What HTML elements is this rendered as (and what kind of a thing is it)? From the context, it sounds as if it might be an image with a caption? In that case, should we use the figure and caption elements? And should the title be an h3 or something similar (depending on its position in the page)? If you wanna be very nitty gritty, the StyledContainer could probably be an article instead of a div, too, but that's not very important.

Also, the images don't have any captions or alt text, which is an accessibility issue. Based on the usage in the new code, I think the typography should be put in a figcaption component, linked to the images figure component.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

Choose a reason for hiding this comment

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

Did you push the changes? For some reason, I don't think I'm seeing them? 🤔

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

Super; much better 😄 🙌🏼

gap: theme.spacing(2),
flexDirection: 'column',
}));
export const StyledTitle = styled(Typography)({
Copy link
Contributor

Choose a reason for hiding this comment

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

Based on the usage (and my understanding from the screenies you posted), it feels like this should be an h2 element if I'm reading it right? But that's a minor thing, and I'll leave it up to you, whether or not to handle that.

Suggested change
export const StyledTitle = styled(Typography)({
export const StyledTitle = styled('h2')({

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants