Akelos Framework v1 forum archive. This forum is no longer maintained. To report bugs please visit https://github.com/akelos/akelos/issues

Tutorials: Contributing to Booklink tutorial

Bottom of Page

1 to 6 of 6

  1.  
    • CommentAuthoralake
     
    My apologies for any typo or grammatical error you might find. English is not my mother tongue and I would really like you to help me improving and fixing errors in this document.

    I clicked on the link in this text and was told:
    Forbidden

    TICKET_CREATE privileges are required to perform this operation.

    As a native English speaker, I'd like to congratulate you on the quality of your English as well as the quality of the whole project. There was nothing that couldn't be understood because of your English. I did want to make a couple of changes, but I got the above error message.

    I'd like to create an Akelos project that wouldn't have an underlying database, but would be used to test features of Akelos. An example would be a demo of using the i18n feature.
    •  
      CommentAuthorbermi
     

    Hi Alan,

    Thanks for your contributions and for the encouragement :D

    The TICKET_CREATE error you got in the Trac basically means that you need to create a trac account to open tickets.

    You can simply drop me an email for changes in the Booklink tutorial. The original tutorial is located at doc/tutorial.markdown, just edit the errors you found and send me back a copy or submit a ticket at trac.akelos.org

    • CommentAuthoralake
     
    I was concerned over two things. First was the problem of migrating any changes to the other languages. The other was in giving you, Bermi, the opportunity to review changes before incorporating them. Both of these problems are solved by adopting the option of editing doc/tutorial.markdown and sending back a copy. To make any changes easy to find, I will put my initials, ahl, next to the change.

    As I update Akelos frequently, my only challenge will be to submit a changed file before I overwrite it with a new one. I will also put a first line in the document indicating which release I received the document with. This way, you'll know whether we're both working on the same release of the document.
    •  
      CommentAuthorbermi
     

    Keeping track of changes can be easily done using subversion control version system. By generating a diff me and other language maintainer's can see your changes quickly. And if you update your Akelos working copy frequently your local changes will not be affected if you use subversion. This is a sample diff rendered as html by Trac for a change in the booklink documentation.

    You can see instructions on how to get the source from and how to generate a patch with your changes on a unix box using the command line svn client. On windows you can use Tortoise SVN for checking out the source and generating diffs.

    • CommentAuthoralake
     
    The only change I could recommend is at line 144, but I have a question about it. This statement says "safely remove the framework setup files." I found one setup file at script/setup, but the wording implies that there are others. If so, I'd like to see all of them specified.

    144 After your application has been installed correctly you'll see a welcome message at http://localhost/booklink. Now you can safely remove the framework setup files (they won't be accessible if a `/config/config.php` file exists)

    144 After your application has been installed correctly you'll see a welcome message at http://localhost/booklink. Now you can safely remove the framework setup files. They won't be accessible if a `/config/config.php` file exists. The framework setup files are script/setup...

    Because I had this question, I thought it better to not create a patch. Only then can I make certain that I understand how to do it.
    •  
      CommentAuthorbermi
     

    alake, we are working on removing those files automatically. Once that is ready we will remove the setup removal recommendation from the booklink tutorial.

1 to 6 of 6

  1.  
Back to Discussions Top of Page