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

Adds a dev section to the bottom of the dependency tab #712

Merged
merged 5 commits into from
Jun 13, 2021
Merged

Conversation

zbynek
Copy link
Contributor

@zbynek zbynek commented Jun 4, 2021

Related to issue https://issues.jenkins.io/browse/WEBSITE-386

Adds a dev section to the bottom of the dependency tab:

Plugin in BOM

image

Standard plugin

image

... and a link to detailed usage stats in the sidebar

Same for all plugins

image

CC @daniel-beck

@zbynek zbynek requested a review from a team as a code owner June 4, 2021 20:54
@zbynek zbynek force-pushed the dev-info branch 2 times, most recently from 84bc50d to 9c839a6 Compare June 4, 2021 21:42
and the following depndency snippet:
</>
</p>}
<pre>
Copy link
Member

Choose a reason for hiding this comment

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

we have the plugin to make things click to copy if its useful here. I was going to say I don't know who would find the maven coords useful till I saw the jira ticket.

const [isCopied, handleCopy] = useCopyToClipboard(3000);

</div>
<div className="sidebarSection">
<h5>Links</h5>
{plugin.scm && plugin.scm.link && <div className="label-link"><a href={plugin.scm.link}>GitHub</a></div>}
{plugin.scm && plugin.scm.link && <div className="label-link"><a target="_blank" href={plugin.scm.link} rel="noreferrer">GitHub</a></div>}
Copy link
Member

Choose a reason for hiding this comment

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

I'm generally not a fan of forcing new tabs to happen, takes away the agency from the user. Is there a request for new tab, or just a preference?

@halkeye
Copy link
Member

halkeye commented Jun 4, 2021

Couple small notes but looks good to me.

@zbynek
Copy link
Contributor Author

zbynek commented Jun 7, 2021

@daniel-beck any 👍/👎 on including the Maven dependency? It was requested in a comment, so it extends the scope of your ticket. Hopefully it's hidden well enough not to bother majority of users and still provides some value for plugin devs.

@timja
Copy link
Member

timja commented Jun 7, 2021

I love including the maven dependency, I think I would use it a lot

@daniel-beck daniel-beck self-requested a review June 8, 2021 13:17
@zbynek zbynek force-pushed the dev-info branch 2 times, most recently from d0309ca to af6ce07 Compare June 8, 2021 20:42
@zbynek
Copy link
Contributor Author

zbynek commented Jun 8, 2021

@halkeye screenshots updated to show the clipboard copy buttons. It's now extracted to a component, so the release tab changed slightly as well:
image

@halkeye
Copy link
Member

halkeye commented Jun 8, 2021

@halkeye screenshots updated to show the clipboard copy buttons. It's now extracted to a component, so the release tab changed slightly as well:

Thats really awesome. I try to (remember to) make things components as much as possible so its easier to refactor and improve. This is a great improvement

@daniel-beck
Copy link
Contributor

Ironically this will be least useful for plugins that have tons of dependencies already, because the bottom of that page is very far down 😄 Perhaps this could be inserted at the top of the "Dependent plugins" section, which is typically the long section for popular dependencies (especially detached plugins), and also makes sense semantically ("How to add a plugin to this section")?

@zbynek
Copy link
Contributor Author

zbynek commented Jun 9, 2021

@daniel-beck thanks for the suggestion, I moved the dependencies up.

@zbynek zbynek requested a review from daniel-beck June 9, 2021 20:42
@zbynek
Copy link
Contributor Author

zbynek commented Jun 12, 2021

@daniel-beck OK to merge?

Copy link
Contributor

@daniel-beck daniel-beck left a comment

Choose a reason for hiding this comment

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

Thanks 👍

Looking forward to seeing it live!

src/components/MavenDependency.jsx Outdated Show resolved Hide resolved
Co-authored-by: Daniel Beck <1831569+daniel-beck@users.noreply.github.com>
@zbynek zbynek enabled auto-merge (rebase) June 12, 2021 16:47
@zbynek zbynek merged commit c9bca76 into master Jun 13, 2021
@zbynek zbynek deleted the dev-info branch June 13, 2021 16:53
@halkeye halkeye changed the title Add more information for plugin developers Adds a dev section to the bottom of the dependency tab Dec 19, 2021
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