search

modxcms / docs

7 stars 9 forks source link

[Edit Suggestion] Custom Manager Pages Tutorial #230

Open jarofgreen opened 6 years ago

jarofgreen commented 6 years ago

Page Title

Custom Manager Pages Tutorial

URL

https://docs.modx.com/revolution/2.x/developing-in-modx/advanced-development/custom-manager-pages/custom-manager-pages-tutorial

Issue or Suggestion

This is out of date - it references Actions.

As you can read in https://docs.modx.com/revolution/2.x/developing-in-modx/advanced-development/custom-manager-pages/custom-manager-pages-in-2.3 actions are now gone.

Mark-H commented 6 years ago

That page already has a note saying:

If you want to develop a CMP for MODX 2.3 or later, then please read Custom Manager Pages in 2.3

I can imagine it's easy to overlook that, though. Any suggestions on how to move forward with this?

jarofgreen commented 6 years ago

It does. I totally missed that, sorry. I think because I knew I was looking for a piece of the guide rather than the whole thing, so I skim read over it.

Since Security Support for 2.2 has long ended - I believe - how about just removing this page, and putting in some place holder text saying "This now references something only used in older version. If you really need to see it, please see this" - and link directly to an archive version elsewhere?

In a versioned help system (See https://symfony.com/doc/current/components/asset.html and the "4.0 version" dropdown in the top right) this would just be deleted, so I guess the issue is how do you want to treat this in the non-versioned help system you have? But I would argue the docs should only reflect what you can do in currently supported versions.

Thanks for your reply,

Mark-H commented 6 years ago

There is some (early) work being done on implementing a versioned documentation site. Hopefully that'll be more or less launchable in 2-3 months so we can start improving version-specific docs and archiving things per version.