A quick update on some recent activities.
The engineering team is steadily improving our code base and should announce our v23 soon. I’m personally looking forward to this major step as the merge of our cloud branch and community branch will be a starting point to implement new features. It will also purge a good list of issues.
But today I wanted to share the work we are doing on the documentation. We are revamping the documentation step by step to improve usability and help new Dgraph users as well as seasoned practitioners to leverage the power of Dgraph.
We are reviewing each page and organizing the content more clearly into concept, task, tutorial, or reference pages. We are also taking the opportunity to re-test the instructions and correct them when needed. We are also including some of the great work of the community.
For example you may want to check
- An new explanation of the DQL syntax coming from a discuss post.
- The Glossary
- The Dgraph overview or the DQL Quick Start
Other technical pages are also being reviewed :
- Installation details
- Importing and exporting data
- Data migration
We are also doing some technical work to have the search working on the older versions. It was broken and we had to review the logic between Hugo, Netlify, Algolia crawler and indexes. Some fun scripting involved and some hiccups to expect as I’m testing the solution at the moment. So don’t worry if you see some messages about the current version in the doc. I’ll post when the search capability will be fully functional.
It’s a tedious work but very rewarding as it’s an opportunity for the team to go into some feature details. As I used to say, It’s surprising what you can learn by just reading the doc ! But the doc has to be readable.
It’s a continuous effort and we expect to have the whole doc revamped this quarter. We will also review all the tutorials.
Feel free to share you advice on the tutorials you found useful and the ones you would like to see !