Contributor Invite: Improve documention for ejabberd's Jabber clients

About this Contributor Invite:

  • Task Area: Documentation
  • Effort rating: 2/5
  • Skills required: Being a FreedomBox user, English

Description of the Problem:

Ejabberd is an instant messaging server that FreedomBox provides. Once this service is setup, a user needs to install and configure a client application to connection to the XMPP/Jabber instance network. Providing the details for configuring the clients involves providing many details about the server. It can be overwhelming to new users. And currently, our manual does not adequately document the process of connecting to ejabberd server from Jabber clients. This has left our users under-informed.

What we ask of you:

Document the process of connecting to ejabberd server from Jabber clients in the FreedomBox Manual. In order to get this documentation entered into the FreedomBox Manual within the FreedomBox OS, you simply need to edit a wiki page hosted on https://wiki.debian.org. Please edit the following page: https://wiki.debian.org/FreedomBox/Manual/ejabberd

We ask that you make the following edits to the ejabberd manual page:

  • In Ejabberd manual page for FreedomBox, write a section about configuring Xabber app on Android to connect to FreedomBox server with screenshots.
  • In Ejabberd manual page for FreedomBox, write a section about configuring Gajim app on GNU/Linux to connect to FreedomBox server with screenshosts.
  • In the configuration instructions, the domain name used should not be an IP address but a real-world domain name such as myserver.freedombox.rocks.

Link to the issue in GitLab: https://salsa.debian.org/freedombox-team/plinth/issues/184

How to claim this Contributor Invite :

Do you want to accept this invitation to contribute? If so, follow these steps:

  1. Comment on this forum post indicating that you would like to claim the invite. This will prevent multiple people from working on the same issue at the same time.
  2. Register an account with our GitLab instance and begin making your contributions on the GitLab issue page for this task. You can use the comment section of this forum post to ask questions, but the bulk of the development discussion should happen on GitLab.

Resources:

If you need help with this issue, please feel free to ask for it from members of our core team:

  • Sunil Mohan Adapa (@sunil): Lead Developer & Code Reviewer
  • Joseph Nuthalapati (@njoseph ): DevOps Engineer, Developer, & Code Reviewer
  • James Valleroy (@jvalleroy) : Release Manager, Developer, & Code Reviewer