•  
      request #28297 External references in the default MainPage
    Infos
    #28297
    Manuel Vacelet (vaceletm)
    2022-11-23 14:44
    2022-09-12 10:14
    29858
    Details
    External references in the default MainPage

    When default MainPage is created, there are a bunch of links/help that points toward external content. In OnPremise setup without internet access users are frustrated because they cannot get this documenation.

    Questions:

    • Is there an offline documentation that could be shipped together with Tuleap ?
    • Is it possible to customize the content of default MainPage so we adapt the content to Tuleap ?
    Mediawiki Standalone
    Empty
    Empty
    • [ ] enhancement
    • [ ] internal improvement
    Robert Vogel (rvogel), Dejan Savuljesku (dsavuljesku)
    Stage
    Robert Vogel (rvogel)
    Closed
    2022-11-23
    Attachments
    References
    Referenced by request #28297

    Follow-ups

    User avatar

    I close this one as the new Main_Page is delivered as part of 14.2 and the issue I reported about the missing sidebar as now its own request


    • Status changed from New to Closed
    • Connected artifacts
    • Close date set to 2022-11-23
    User avatar

    About the missing sidebar: could you please add $GLOBALS['wgDebugLogGroups']['tuleap-connection'] = "$IP/cache/tuleap-connection.log"; in the LocalSettings.php of your wiki and then load the page again. Could you then provide me the content of tuleap-connection.log? We should then know more about why the sidebar is not displayed.

    User avatar

    Did you run php maintenance/update.php afterwards? With this command the script to overwrite the mainpage is called.

    I didn't change anything in the installation process, we rely on the REST endpoint of the wiki farm with PUT /mediawiki/w/rest.php/tuleap/instance/$INSTANCE_NAME

    User avatar

    That is the old default main page and not the new one. Did you run php maintenance/update.php afterwards? With this command the script to overwrite the mainpage is called.

    User avatar

    Do I understand correctly that you proposing to create another mediawiki page with a small doc and extensions and link to this one from the mainpage? Or wouldn't that be something for the mainpage and link from mainpage to the online doc for most necessary extensions like Visual Editor directly? Should we keep some external links on the mainpage or just internal ones?

    No, I was not clear enough. My idea is to have a part of tuleap documentation that is refereed to in each MediaWiki Main_Page. There is already one for legacy MW: https://docs.tuleap.org/user-guide/documents-and-files/mediawiki.html

    as for the Sandbox: we could add a call to action e.g. create a paragraph containing headlink, text and an internal link to get used to wikitext. It will be a non existing page for the first user who will try this out, that's why we cannot have this on the page directly. If we have this the info section about mediawiki on the mainpage this would be a good combination with sandbox to try it out.

    Would it be possible to mock that up ?

    User avatar

    Yes I see the point with tuleap documentation - if there is nothing about mediawiki it makes no sence to have this.

    Do I understand correctly that you proposing to create another mediawiki page with a small doc and extensions and link to this one from the mainpage? Or wouldn't that be something for the mainpage and link from mainpage to the online doc for most necessary extensions like Visual Editor directly? Should we keep some external links on the mainpage or just internal ones?

    as for the Sandbox: we could add a call to action e.g. create a paragraph containing headlink, text and an internal link to get used to wikitext. It will be a non existing page for the first user who will try this out, that's why we cannot have this on the page directly.

    If we have this the info section about mediawiki on the mainpage this would be a good combination with sandbox to try it out.

    From my experience: users will adapt their mainpage to their needs, like setting links to important wikipages or fill with info how the wiki is structured or maybe some anouncement boxes. But this is hard to define without content and each wiki is used in its own way. That's why we have the sandbox on our default mainpage because the users will change it for their specific needs in their wiki.

    User avatar

    Thanks for the proposal, a few things out of my mind:

    1. I don't think it's a good idea to point toward Tuleap documentation as it won't contains anything related to MediaWiki and what people expect is documentation about MediaWiki. Or Maybe we could have a simple MediaWiki page that just say that (plus the available extensions for instance) and the points toward the online doc ?
    2. What are the recommended good practice related to Wiki usage in your experience ?

    For 2, I'm wondering what people usually like to see when they load a wiki ? While recent change is a good thing, I'm not quite sure that highlighting "Sandbox" is what final users will expect. Maybe there are key informations that should be there (idk, "Write a description of the wiki content" or "Explain to your users what they should expect to find here", etc) ?

    User avatar

    Mainpage proposal:

    • section 1: link to a sandbox wiki page to test and try out wikitext
    • section 2: link to tuleap documentation *section 3: recent changes - will be empty on new instance but users can see with usage of wiki which pages are created and edited

    We could also add some links other tools (e.g. documents) or we could add an icon like you do on an empty documents tool page.


    User avatar

    No, AFAIK there is not official offline documentation available.

    That's not a big issue, even less now with the Visual Editor. Was just to be sure I didn't miss sth.

    Yes. We do this for our BlueSpice distribution. It can be implemented easily. Please be aware that you may need to maintain language variants of the Main_Page content for each language supported by the installation mechanism.

    That's great. We won't need TransaleWiki as we will only have it for the official languages of Tuleap (EN & FR ATM)

    User avatar
    Robert Vogel (rvogel)2022-09-15 09:25
    last edited by: Robert Vogel (rvogel) 2022-09-15 09:25

    Is there an offline documentation that could be shipped together with Tuleap ?

    No, AFAIK there is not official offline documentation available.

    Is it possible to customize the content of default MainPage so we adapt the content to Tuleap ?

    Yes. We do this for our BlueSpice distribution. It can be implemented easily. Please be aware that you may need to maintain language variants of the Main_Page content for each language supported by the installation mechanism. We may be able to use the TranslateWiki.net project for this but this depends a little bit on how big and complex (tables/images, ...) the content is. For BlueSpice we don't use TranslateWiki.net but maintain the translations manually.