Moving FAQ to controllers

These requests for comments/change have lead to an implemented feature that has been successfully merged into the 3.2/Rhea branch. Everything listed in this forum will be available in phpBB 3.2.
Post Reply
User avatar
nickvergessen
Former Team Member
Posts: 733
Joined: Sun Oct 07, 2007 11:54 am
Location: Stuttgart, Germany
Contact:

Moving FAQ to controllers

Post by nickvergessen » Mon Nov 17, 2014 10:03 pm

While trying to make it easier to translate the FAQs, I'm removing the strange array we use there and switch to normal language strings.
As this already changes most of the content, we might aswell just move the FAQs to controllers.

Now there are multiple questions:
  1. Which routes should be used?
    I would suggest using /help/faq for https://area51.phpbb.com/phpBB/faq.php and /help/bbcode for https://area51.phpbb.com/phpBB/faq.php?mode=bbcode
    This allows other extensions to add their help sites under the same prefix.
  2. The second question is where to put the controller. We have multiple options there:
    • Using the feature as second namespace: ./phpbb/help/controller/faq.php (this is what the API PR uses atm: https://github.com/phpbb/phpbb/pull/3100/files )
    • Using controller as second namespace: ./phpbb/controller/help/faq.php
    • Moving it to an extension: ./ext/phpbb/help/controller/faq.php
    I think 1 and 3 would make sense, whereby 1 and 2 are easy and 3 requires the installer to enable exts afterwards...
Member of the Development-TeamNo Support via PM

User avatar
Meis2M
Registered User
Posts: 411
Joined: Fri Apr 23, 2010 10:18 am
Contact:

Teams for developing 3.1 and 3.2

Post by Meis2M » Tue Nov 18, 2014 10:18 am

+1 for that.

Nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 297
Joined: Sun Apr 13, 2014 1:40 am
Location: Paris

Re: Moving FAQ to controllers

Post by Nicofuma » Tue Nov 18, 2014 1:28 pm

I would say:
- /help/faq and /help/bbcode (in a /config/routing/help.yml file ^^)
- Use the feature as second namespace and maybe we will move it to an extension later, when we could manage extensions dependencies and when we will rewrite the installer (and so when it will be able to install extensions).
Member of the phpBB Development-Team
No Support via PM

User avatar
naderman
Product Manager
Product Manager
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: Moving FAQ to controllers

Post by naderman » Fri Nov 21, 2014 5:57 pm

Let's keep the FAQ in core rather than an extension. I also agree that it should be phpbb/help/controller/faq.php, so we keep it somewhat a separate subsystem. The URLs you suggested sound good.

User avatar
AmigoJack
Registered User
Posts: 92
Joined: Wed May 04, 2011 7:47 pm
Location: グリーン ヒル ゾーン
Contact:

Re: Moving FAQ to controllers

Post by AmigoJack » Wed Jan 14, 2015 8:10 am

Every page that is not searchable is quite useless - "normal" people using the keyword search might get what they want if not only posts would be returned as results. Likewise the FAQ is visited rarely. Even the whole ACP suffers from not being searchable, which both affects rookies and experts (3.0.x: Search in ACP).

Post Reply