10 replies to this topic

[ogerboss]

Hi all, I have some news for you.

A new installation guide - Requiem meets Confluence

We decided to test a software named Confluence, which has the potential to serve as a wiki-like online documentation for Requiem. Since it is a commercial product, we are currently evaluating if its worth its money for our purposes. So please take a look at our minimal example, the new installation guide and give me some feedback about.

For now you cannot leave comments in Confluence, I only granted view rights to anonymous users. If the side asks you to log in, it means that tried to reach a part that is off-limits for you.

You might wonder why we chose a commercial software, instead one of the free wiki pages. Let me explain the reasoning behind this:
At present, we are migrating our bug tracker from a free one (the one integrated in Bitbucket) to a more powerful commercial one (Atlassian JIRA). This step has become necessary because the complexity of our issues (these can e.g. be bugs, balancing proposals or new features) became too complex for the simple tracker. Recently I wasted lots of time by looking for particular comments on a specific issue, e.g. IDs of not yet transformed bandits. Also the sorting options for issues are limited and the more issues one has, the more time it consumes to find the ones you are currently interested in. This JIRA bugtracker can be closely intertwined with Confluence, e.g. comfortable linking to particular issues or generating status reports for projects and the marketing says that it is the ideal place for discussing new ideas. After finding out, that it is possible to open specific parts of the Confluence to public access, I had the idea to use it as a platform for team-internal discussions and public documentation at the same time.

Edited by ogerboss, 28 June 2014 - 01:03 PM.

[calfurius]

Awesome Ogerboss, does that mean you're back from that work thing you were doing?

[ogerboss]

In response to post #16027690.

I am back since last weekend, but as I wrote in the article, I spent this week setting up a new issue tracker to streamline development, instead of risking to screw up things in the final stage. But from mid of July I will be away again for two weeks on another workshop.

[Ghengisbob]

In response to post #16019620.

The new installation guide looks good to me!

[FinnWolfshorn]

In response to post #16019620. #16032945 is also a reply to the same post.

Second this, I'd say it makes the procedure about as clear as it gets and is eye-friendly too. (Maybe you could make the sentence "To install Requiem, you need to download both the last major and (if available) minor version." bold or underlined to make sure everybody gets it.)

[ogerboss]

In response to post #16019620. #16032945, #16037725 are all replies on the same post.

A good idea, I have now placed this information in a nice warning box.

Edited by ogerboss, 29 June 2014 - 10:16 AM.

[heckur]

The installation guide looks very good. However, I'm missing an option for users to report bugs or suggestions to improve it. Like in the https://requiem.atla...talling Requiem page, the SkyUI link is incorrect. How to report such an issue?

[ogerboss]

In response to post #16082000.

The link is now fixed.

If I want it, I can enable anonymous comments on the accessible pages. However, for a first test I decided to not activate this feature.

[ahShameA]

great stuff. requiem is such a vast mod and changes so much, it really needs an easy to navigate centralized repo like this. and the infomation is really nicely presented and clear in the initial articles too.

[ogerboss]

In response to post #16085005.

Confluence is not intended to replace the manual, because I do not want to force anyone to be online just to view the documentation. But I agree that navigating Confluence might be easier than a long pdf-file, that's why we are currently testing it out.