We’re Now Hosting Valadoc.org

Daniel Foré
elementary
Published in
2 min readNov 9, 2016

About a year ago, we contributed a major visual overhaul to Valadoc.org. This is an essential tool for elementary OS development. Good docs are important both for new and old developers. However, we’ve recently seen some trouble with the server. There has been downtime and, more importantly, search stopped working completely. But, with a little bit of elbow grease, we’ve addressed the situation.

We’ve seen a number of Valadoc.org mirrors sprout up, all with their own problems as well (namely, links to specific pages broken, which is also a huge issue). Instead of creating our own mirror, we reached out to Florian Brosch (who runs Valadoc.org) and started drafting a way to move forward that keeps up time of the website high and ensures that important features that were broken got fixed.

After a brief incubation period, we’re now officially serving Valadoc.org from elementary servers hosted by Digital Ocean. Deployment is automated with Ansible just like our other websites and you can rest assured that we’ll take the same care with this new addition to the family.

Although Valadoc.org doesn’t collect, read, accept, or store any personal information, we’re still planning to implement HTTPS/TLS with Let’s Encrypt very soon. If you’re curious, you can read more about our web architecture in our previous blog post.

We’ve also put together a new GitHub organization to help maintain Valadoc.org. Florian is still the owner of this organization and will still have the ability to lead its development path. This is an independent organization that elementary is proud to contribute to.

Thanks to some quick work by Blake, search is working again on Valadoc.org. While addressing an issue with broken link redirects, Lewis also took the time to make sure that links to specific pages of documentation were easier to read and write. But don’t worry, the old style links still work, so anything pointing to Valadoc.org won’t be broken:

Old: http://www.valadoc.org/#!api=gtk+-3.0/Gtk.Label

New: http://valadoc.org/gtk+-3.0/Gtk.Label

We’re very excited to make sure that Valadoc.org is still the best resource for Vala documentation. If you visit the site, you’ll see that it now provides links to several resources upfront, and we plan to continue to make this landing page more and more useful as time goes on.

Thank you to all our supporters who make it possible for us to take on projects like this. If you’d like to get involved in Valadoc.org development, you can fork the website on GitHub. We look forward to your pull requests!

--

--