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

Remove custom documentation of PhpStorm Gerrit plugin in appendix #357

Merged
merged 5 commits into from
Aug 8, 2024
Merged

Remove custom documentation of PhpStorm Gerrit plugin in appendix #357

merged 5 commits into from
Aug 8, 2024

Conversation

pixeldesu
Copy link
Contributor

@pixeldesu pixeldesu commented Aug 7, 2024

While the plugin can be set up, the setup is more convoluted and complex than the widely-used CLI setup that is documented pretty well in the contribution workflow anyway.

So, in order for no one else stumbling upon this, it's best to just remove it.

Not a lot of people in/around the Core circles use the PhpStorm Gerrit plugin. We noticed that there can be some issues with setting it up (depending on how deep you want the integration to go). As the plugin is still useful to some we're not fully removing any mention of it, but instead just link to the Marketplace without providing our own documentation around the plugin usage.

@garvinhicking
Copy link
Contributor

I agree.

We should also remove the page itself, to prevent having an orphan entry (mobile atm, can't add that to the PR)

@liayn
Copy link
Contributor

liayn commented Aug 7, 2024

IMO the existence of the plugin should still be mentioned.
It is super helpful when pushing stuff.
(I do not use any other feature of it, actually)

@garvinhicking
Copy link
Contributor

We could then only link to that plugin via marketplace URL https://plugins.jetbrains.com/plugin/7272-gerrit just like the TYPO3 plugin, and not give any special instructions which would make it our responsibility to describe it more properly?

@pixeldesu
Copy link
Contributor Author

@garvinhicking added the link to the Marketplace now!

@pixeldesu pixeldesu changed the title Remove mention of PhpStorm Gerrit plugin in appendix Remove custom documentation of PhpStorm Gerrit plugin in appendix Aug 8, 2024
@garvinhicking
Copy link
Contributor

@pixeldesu Thanks! Since I'm only on mobile, could you do me two more favors (or wait a bit until I can make it):

  • Add the old anchor .. _phpstorm-gerritplugin: before the gerrit marketplace link, so that references to that section at least resolve to the new overview and not break possible docs pointing towards it
  • Also remove the referenced gerritplugin images referenced in the deleted detail section, since those are not used anymore

:-)

@pixeldesu
Copy link
Contributor Author

Done!

linawolf
linawolf previously approved these changes Aug 8, 2024
Copy link
Member

@linawolf linawolf left a comment

Choose a reason for hiding this comment

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

Good idea, thank you

garvinhicking
garvinhicking previously approved these changes Aug 8, 2024
Documentation/Appendix/IdePhpStormSetup.rst Outdated Show resolved Hide resolved
@garvinhicking garvinhicking dismissed stale reviews from linawolf and themself via eac489e August 8, 2024 10:58
@garvinhicking garvinhicking merged commit f1337a1 into TYPO3-Documentation:main Aug 8, 2024
1 check passed
@garvinhicking
Copy link
Contributor

Thanks!

@pixeldesu pixeldesu deleted the task/phpstorm-gerrit-plugin branch August 8, 2024 11:32
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.

4 participants