Many documentation links are broken 😱

richard · March 6, 2023, 7:00am

Since the move from pluginmanager, a lot of documentation links that are hard coded in the plugins are broken.

I tried to fix this but did not succeed.

It’s apparently impossible to create permalinks starting with /t/ or /c/
On the ‘this page is not available or private’ the global banner does not even show
I will put back some documentation to its old location on that site, but this is a highly undesirable situation.

I propose that going forward we will put redirects from just like we discussed in this topic.

./discourse-custom-wizard/assets/javascripts/discourse/mixins/subscription.js.es6:  "https://discourse.pluginmanager.org/c/discourse-custom-wizard";
./discourse-custom-wizard/assets/javascripts/discourse/controllers/admin-wizards-wizard.js.es6:    "https://discourse.pluginmanager.org/c/discourse-custom-wizard/documentation",
./discourse-custom-wizard/assets/javascripts/discourse/controllers/admin-wizards-custom-fields.js.es6:  documentationUrl: "https://discourse.pluginmanager.org/t/custom-fields",
./discourse-custom-wizard/assets/javascripts/discourse/controllers/admin-wizards-manager.js.es6:  messageUrl: "https://discourse.pluginmanager.org/t/wizard-manager",
./discourse-custom-wizard/assets/javascripts/discourse/components/wizard-custom-action.js.es6:  messageUrl: "https://discourse.pluginmanager.org/t/action-settings",
./discourse-custom-wizard/assets/javascripts/discourse/components/wizard-custom-field.js.es6:  messageUrl: "https://discourse.pluginmanager.org/t/field-settings",
./discourse-custom-wizard/README.md:[Read the full documentation here](https://discourse.pluginmanager.org/c/discourse-custom-wizard/documentation), or go directly to the relevant section
./discourse-custom-wizard/README.md:- [Wizard Administration](https://discourse.pluginmanager.org/t/wizard-administration)
./discourse-custom-wizard/README.md:- [Wizard Settings](https://discourse.pluginmanager.org/t/wizard-settings)
./discourse-custom-wizard/README.md:- [Step Settings](https://discourse.pluginmanager.org/t/step-settings)
./discourse-custom-wizard/README.md:- [Field Settings](https://discourse.pluginmanager.org/t/field-settings)
./discourse-custom-wizard/README.md:- [Conditional Settings](https://discourse.pluginmanager.org/t/conditional-settings)
./discourse-custom-wizard/README.md:- [Field Interpolation](https://discourse.pluginmanager.org/t/field-interpolation)
./discourse-custom-wizard/README.md:- [Wizard Examples and Templates](https://discourse.pluginmanager.org/t/wizard-examples-and-templates)
./discourse-custom-wizard/README.md:- [Report a bug](https://discourse.pluginmanager.org/w/bug-report)
./discourse-locations/README.md::page_facing_up: [**Read the documentation**](https://discourse.pluginmanager.org/c/discourse-locations/documentation)
./discourse-locations/README.md::bug: **[Report a bug](https://discourse.pluginmanager.org/w/bug-report)**
./discourse-locations/README.md:- [Administration Settings](https://discourse.pluginmanager.org/t/administration-settings/298)
./discourse-locations/README.md:- [Locations in Topics](https://discourse.pluginmanager.org/t/locations-in-topics/297)
./discourse-locations/README.md:- [Locations in Categories](https://discourse.pluginmanager.org/t/locations-in-categories/296)
./discourse-events/assets/javascripts/discourse/components/events-message.js:  provider: "https://discourse.pluginmanager.org/t/539",
./discourse-events/assets/javascripts/discourse/components/events-message.js:  source: "https://discourse.pluginmanager.org/t/540",
./discourse-events/assets/javascripts/discourse/components/events-message.js:  connection: "https://discourse.pluginmanager.org/t/541",
./discourse-events/assets/javascripts/discourse/components/events-message.js:  event: "https://discourse.pluginmanager.org/t/543",
./discourse-events/assets/javascripts/discourse/components/events-message.js:  log: "https://discourse.pluginmanager.org/t/543",
./discourse-events/assets/javascripts/discourse/components/events-message.js:      urls[view] || "https://discourse.pluginmanager.org/c/discourse-events"
./discourse-events/README.md:If you've found a bug, please report it through our [bug report wizard](https://discourse.pluginmanager.org/w/bug-report)

I propose that we will create the following redirections on the main domain, change the code to point to these locations, and redirect from there

o https://pavilion.tech/products/discourse-locations-plugin/documentation/
o https://pavilion.tech/products/discourse-locations-plugin/documentation/administration
o https://pavilion.tech/products/discourse-locations-plugin/documentation/topics
o https://pavilion.tech/products/discourse-locations-plugin/documentation/categories
o https://pavilion.tech/products/discourse-locations-plugin/support
o https://pavilion.tech/products/discourse-locations-plugin/support/bug-report

angus · March 6, 2023, 7:58am

I think the simplest way to address this is if you just do a search replace PR on the custom wizard, events and locations plugins?

Not sure this needs to be assigned to me.

richard · March 6, 2023, 7:59am

Didn’t mean to - it auto assigns for some reason, I think that the PMS uses the configured maintainers?

angus · March 6, 2023, 8:03am

I see, yes. We can expand that to include the other members of @development_team and do random assignments perhaps.

cc @merefield

richard · March 6, 2023, 8:18am

I can scientifically prove that this is the worst way of assigning tasks, maybe even better to leave everything unassigned until someone actually starts working on an issue.

angus · March 6, 2023, 1:39pm

I’ve added a site setting to toggle auto-assignments plugin_manager_auto_assign_to_maintainers, default off, so we can control this regardless. Currently being deployed.

angus · March 21, 2023, 3:25pm

@richard Is this issue handled? I’m just going through unclosed issues for the CW plugin.

richard · March 21, 2023, 4:06pm

I’m halfway so please leave it open for now

merefield · July 11, 2023, 4:51am

FYI Canapin from CDCK just chased me/us on this.

Does it make sense to commit what you have and follow up with the others as phase 2, or trivial to finish this off?

richard · July 11, 2023, 7:08am

I’m on holiday so I am not going to do much more than an occasional post in the next weeks.

I think most redirections as stated in the first post are there. If you have time to spend then feel free to change links in the code, but please, only to the links stated in the first post, to avoid things breaking again in the future.

merefield · July 11, 2023, 7:19am

Let’s discuss on your return. I have plenty to be getting on with right now Have a great