Avançar para o conteúdo principal

test


Last week has been spent mostly on writing good documentation and trying to see what else can be improved around whats done. Check out below, to see which doc files are about to be updated so far!

Prosody documentation:

/doc/prosodyctl- added command entries
/doc/prosodyctl - Added a reference to the plugin installer documentation page
/doc - Added a reference to the plugin installer documentation page
/doc/plugin_installer - Created this new page
/doc/plugin_installer - Added introduction, pointing to links regarding prosodyctl, core and community modules, installing modules manually
/doc/example_config - Added the new field for the plugin installer directory
/doc/configure - Added info about configuring the installer's path

Difficulties/Considerations

Not too sure what to do with /doc/installing_modules. I could update the installer info here, but I feel it needs a dedicated space. This space is still useful on its own, since core plugins are still coming installed in the old way.
Code seems to be working fine so far, but somehow I'm always afraid that something is amiss O.o
I haven't been able to run my own version of prosody's website, which I'd like to do. Well, I was, but there is these problems with hyperlinks, that are explained in the website's readme file. Some writing tricks are needed to make them work, and seems like people usually do this via nginx, which I never use. I used apache, to test the installer fetching modules, but I've got no idea how to make the hyperlinks work there. I dwelled on this apache/nginx a bit, but ended up moving on, as I feel it isn't really the important thing to focus.
I should try to make a true prosody package too. I've running things from source now, since it is the absolutely most convenient way for developers to work, but that isn't what the everyday user will do. Maybe I shouldn't do so though, the installer might be just included in the next major prosody's release.
Last weeks have been a mess, for some personal reasons. GSoC is ending and I need to lookout for the next steps. I feel I'm not been able to communicate as I should though. Hope this project can be really useful at the end O.o

Future goals

Review documentation
Check what can be improved, regarding docs
Keep checking for core improvements until merge time
Consider updating prosody's pacakge
Prepare final project webpage to showcase work, as requested by GSoC

Comentários

Enviar um comentário

Mensagens populares deste blogue

Sailing!

After some fusion dance, we have some stuff working neatly! Last week was all about the lua environment and improvements aimed at user-friendliness, which you can check down below with latest changesets and demos. Events prosodyctl Removed most development / experimental commands Created a script that is automatically setting up a ready to be served repository will rockspecs for all of prosody's plugins ( demo ) Various improvements/updates to the main commands: list - demo install demos: installing a prosody plugin installing a luarocks library Installation also prints configuration help   remove - demo prosody uses a separate folder to deal with non-standard plugins - demo Users can configure their own path, and override it at any time from the command line if needed - demo Updated the startup utility script regarding management of default/custom installer directories and lua environment Difficulties The greatest obstacles this past week were ...
Enviar um comentário
Ler mais
Prosody's plugin installer is making use of Luarocks to get things working. Therefore, it makes sense that we look a bit into Luarocks to see how it works. Concepts Here is what you need to know. Luarocks uses files, called rockspecs, to get things installed around. These are basically instruction files and they tell the program how to do the work. We can pack the sources and the rockspecs into a single file, called a rock. We can install libraries from both rocks and rockspec files. The code is installed in what is called a rock tree, which is a folder with a specific structure inside, organized in a way to help with the required management of libraries and servers. Installing, removing and list If you are working on debian you can just use: sudo apt-get install luarocks Now, there might be some trouble here and there, depending on your machine, or if you are in a different OS, but the guys at luarocks have tips for almost every possible situation, just che...
Enviar um comentário
Ler mais
Prosody's plugin installer is making use of Luarocks to work underneath the hood. Therefore, it makes sense that we look a bit into Luarocks to see how it works. Concepts Here is what you need to know. From the perspective of Luarocks, Lua Libraries are files called Rocks. Rock files are like a zip file, in the sense that inside there are many files. Most of those files are the sources, which means those are the files that have all the code itself. And then there is a rockspec file. This is like an instruction file, written in Lua, which contains the important information that Luarocks needs to do its job. Things like the location of sources, dependencies and build instructions. The code is then installed in what is called a rock tree. A normal folder, in other words. But this folder is referenced on luarocks documentation, for example, so that things know where to look for when they need to use a particular library. Installing, removing as list If you ...
Enviar um comentário
Ler mais