The tutorial files have errors in them

[GoogleCodeExporter]

Please check the tutorial files in the branch . They have errors

Original issue reported on code.google.com by [email protected] on 6 Dec 2012 at 6:23

[cirulls]

I am in the process of reviewing the documentation on the wiki. It would be useful to flag any known error in the documentation so that I can amend it.

[cirulls]

I tried to post a discussion on the Google Groups mailing list (http://groups.google.com/group/xspec-users) but the post doesn't appear, maybe it needs to be moderated. Just in case, I post the same text here:

I was planning to reorganize the documentation for XSpec in order to update it a bit and possibly make it more user-friendly for those who use XSpec for the first time. I have few questions in order to get started:

• There is documentation on the GitHub wiki (https://github.com/expath/xspec/wiki) as well as on branch wiki. The README for the branch wiki says explicitly: "Automatically created by the Google Code exporter. Not used, as we use the GitHub wiki instead". From conversations I had with Florent Georges and Tony Graham we mentioned to put the documentation in a documentation folder alongside the code. Which one should be the home of the XSpec documentation? If it's the wiki, I'll probably edit it directly on GitHub (with the risk of editing something that others may want to keep), if it's a branch or a documentation folder under master I'll send a pull request when I'm done.
• I quickly reviewed the current documentation and was thinking to merge and structure it as follows (it's just a draft):

01 Introduction
02 Installation
02.01 Windows
02.02 Mac/Linux
03 Hello XSpec
04 Writing Scenarios
05 Running Scenarios
05.01 Running with oXygen
05.02 Running with ant
05.01 Running with maven
05.01 Running with emacs
06 Continuous Integration
06.01 Jenkins
06.02 TeamCity
07 How XSpec works
08 Links

Does it sound reasonable?

[hutchkintoot]

Not sure about the Github wiki. But i guess that it is versioned. To my knowledge versioning is a "must have" requirement for a wiki. So if you edit something out that others think are important they can just fetch it back from the history.

[cirulls]

Wikis should be just like any GitHub repositories (https://help.github.com/articles/adding-and-editing-wiki-pages-locally/), therefore it should be possible to keep track of changes (https://help.github.com/articles/viewing-a-wiki-s-history-of-changes/). If we think that the wiki is the best place to put documentation, I guess I can clone the GitHub wiki (which is not the current wiki branch) and then do a pull request when I'm done.

[cirulls]

I reviewed and updated the documentation on my fork of XSpec. I updated the old links, reorganised the structure of the wiki, tested most of the instructions provided, and added new pages. There are other things I would like to add (e.g. few pages on Continuous Integration) but I hope this is an enhancement to the current documentation.

I tried to merge the changes but I don't seem to have enough permissions to do so. I'm going to ask Florent Georges and Tony Graham to do it or to add me as a collaborator.

[cirulls]

The updated documentation has been merged in https://github.com/expath/xspec/wiki so this issue can be closed.