FAQ

FAQ

Taking SF Wiki Helper into use

I am starting from scratch with an empty project wiki. Is it a good idea to
    start using SF Wiki Helper right from the start?

    I would say no. In the first place it is not necessary. There is no
    existing documentation, so no conflict. If you do not want users to see
    the documentation yet, you can simply restrict access to your wiki until
    the time it can be published. In addition you miss the opportunity to
    learn the SourceForge markdown flavour. This is so much easier on-line
    because you can preview everything. Off-line you will not be able to
    preview typical SourceForge markdown like artifact links. Another advantage
    is that after finalising the first version of your wiki on-line, sfwiki can
    download your wiki and you immediately have the right set-up for your
    off-line working directory.

Publishing wiki pages

Why do I have to do some things manually when publishing my wiki pages?
    Can't sfwiki do that for me? This concerns:
    - renaming and deleting pages
    - changing attachments

    sfwiki is using the Allura API. The only things you can change by using this
    API are the contents (written in markdown) and the labels of a wiki page.
    You cannot rename the title of a page, change a page's  attachments or
    delete a page. But if you do all these things offline in advance, sfwiki
    will generate a todo list of changes you have to change manually when
    publishing the changes in contents and labels.

Security

Why do I have to enter a bearer token?

    A bearer token is the only way to give sfwiki access to your user account,
    so it is authorised to use the Allura API to update your wiki pages. The
    alternative is to turn this script into an application that can do proper
    OAuth negotation.

How do I obtain a bearer token?

    You must first register for an OAuth consumer token at
    <https://sourceforge.net/auth/oauth/>. Once you have registered, the
    consumer token allows you to generate a bearer token that gives sfwiki
    access to your user account without having to perform the OAuth
    negotiation.

Is it safe to use a bearer token?

    There is certainly a risk. If somebody gets hold of your bearer token, a
    REST application using the Allura API can give him or her potentially full
    access to your account. To reduce this risk you could revoke the bearer
    token after use and generate a new one when needed. The sfwiki script itself
    does not display the bearer token and will not retain it in any way after
    publishing your wiki pages.

[Home]