feat: extract /plugins

[thiskevinwang]

Preview

Description

This moves external plugins to a new /plugins route.

This is in support of unblocking versioned-docs (core docs).

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1201528333146695

[zchsh]

💖 This is awesome! resolve-nav-data looks way cleaner and simpler, and I'm really liking the new organization on the /plugins route.

Reviewed the diff and also pulled the branch down locally and checked things out, and I think you're good to go ahead and delete all the crufty now-commented-out code in resolve-nav-data 💯 Apart from that, and the index.mdx page (which we likely need Packer team help filling it), this feels nearly ready to ship, IMO!

[zchsh]

💖 Love that this is stubbed out

[thiskevinwang]

@azr would you be able to add some text here? Or tag someone else? 🙏

[azr]

Yes !

[azr]

This is super dope, I added content to the new plugin page, from an already existing plugin page. I think it makes sense there, but these pages sound a bit duplicate now.

Maybe that section:

Should just be about extending packer ? Or not even be here anymore 🤔

BTW, I found myself wanting to click on the version of a plugin, to sort's of go on the release page. If that's easy, that'd be nice :D

Is there a documentation somewhere on how to test documentation rendering ?

Super nice work !!!!

[azr]

Oh, forgot to add:

I think these overviews should be at the top, and not tested. They kind of have the same content.
Edit: but it sounds like this is remote-docs side and not this side, so never mind !

[thiskevinwang]

@azr

BTW, I found myself wanting to click on the version of a plugin, to sort's of go on the release page. If that's easy, that'd be nice :D

Versioning for plugins is on our road map! We're aiming to handle that shortly after the core versioned-docs rollout.

I think these overviews should be at the top, and not tested. They kind of have the same content.
Edit: but it sounds like this is remote-docs side and not this side, so never mind !

Yea. These nested "Overview" pages are generated from nested index.mdx files in the plugin repos

Ex.

UI	Repo

I do agree though that the "Overview"s should be merged into a top-level one. We'll likely need a more solidified pattern to handle this.

Is there a documentation somewhere on how to test documentation rendering ?

@azr are you referring to manual testing? Or unit/integration testing? Or something else?
@zchsh any context from your end here?

[zchsh]

@azr Unfortunately we don't have a super smooth workflow at present for testing rendering documentation from work-in-progress in remote plugin repos. I think @sylviamoss set up a workflow involving local .zip files so will have more insight here 👍 (From what I can tell we've retained the local .zip option with this refactor, cc @thiskevinwang in case you can confirm)

[zchsh]

@thiskevinwang Realized one missing piece here might be redirects - I think we'll want to generate redirects for any external plugins. For example, I think we want to redirect from /docs/datasources/hashicups/coffees to /plugins/datasources/hashicups/coffees.

Seems like a high-level docs/datasource/* >> plugins/datasources/* redirect would conflict with any built-in plugins... so my hot take is I think we'll need to go a level down and do eg /docs/datasources/hashicups/* >> /plugins/datasources/hashicups/* redirects. But very open to other approaches 🙇‍♂️

[thiskevinwang]

@thiskevinwang Realized one missing piece here might be redirects - I think we'll want to generate redirects for any external plugins. For example, I think we want to redirect from /docs/datasources/hashicups/coffees to /plugins/datasources/hashicups/coffees.

Seems like a high-level docs/datasource/* >> plugins/datasources/* redirect would conflict with any built-in plugins... so my hot take is I think we'll need to go a level down and do eg /docs/datasources/hashicups/* >> /plugins/datasources/hashicups/* redirects. But very open to other approaches 🙇‍♂️

Ah yea, thanks for catching this @zchsh. I'll get those sorted out.

[thiskevinwang]

@zchsh Added redirects in efa2d0e

... I think we want to redirect from /docs/datasources/hashicups/coffees to /plugins/datasources/hashicups/coffees.

Quick smoke test: this works now

[azr]

LGTM !!

[nywilken]

🙌🏽 🎉 🚀

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.