Documentation site design update

Announcements
1

Last week we launched a new design for our RT documentation site. It addition to the nicer look, it has clearer categories, much improved search, and cleaner navigation.

Alongside it, we stood up a separate home for developer documentation at https://developer.bestpractical.com. This makes it much easier to find the REST 2 API docs and other resources like the guide to writing extensions and help with scrip actions and conditions.

Some key improvements:

  • A much improved search, which you can use from either site.
  • The page defaults to RT 6.0.3 as before, but all versions are still available. Select the major version from the menu to search an older version. Search results are scoped to that version. Additional results are shown for the latest (currently RT 6.0.3) in case we added something in newer versions.
  • RTIR docs are updated also.
  • Upgrade guides are easier to find, so if you have been putting off a move to the latest RT, this is a good moment to take it on.

You can find more on our blog. As always, we build these docs from the source RT docs, so you also have all of the core information in your installed RT. Check out the new site, and if something is still hard to find, let us know.

2

I think it could do with a more obvious link from the docs site to the developer site to help people find the Perl API. The latter is what I seem to end up looking at most of the tim.e whilst working on local customisations, but now it seems hidden away from newer users.

Its going to take a while to get used to, especially as the columns in the core module list now read across as rows rather than down as columns (I wondered where RT::Ticket was when it wasn’t above RT::Tickets! :slight_smile: )

3

We settled on a button in the upper righthand corner, and it’s in the same spot on both sites. Hopefully that becomes more natural once you know it’s there. And if you’re more dev focused, you can probably just start going directly to https://developer.bestpractical.com.

The new search is much better and is a very quick way to find things now. I just tried a search for “RT::Tickets” and that page was the first result. I wonder if this might become faster than scanning the big index. No matter how many times I referenced RT::REST2 on the old site, I would have to scan the whole list every time.

Thanks for the feedback!