Closed ismay closed 3 years ago
@ismay I definitely agree with this, especially when it comes to things like interactive docs. We want to be careful not to get ourselves into a position where we let the site stagnate or spend all our time developing it, but I think it's too much work trying to grapple with Jekyll now anyway.
If/when we move to an SSG docsite (like Docz which is based on Gatsby) we should consolidate all the docs here and also update the site & blog to use the same system.
If we do that, we could do that in a new repo, We could build on the "Hub" brand too, e.g. dhis2/developer-hub
or dhis2/dev-hub
for short.
One consideration is that historically the DHIS2 docs was hosted here (github.com/dhis2/dhis2.github.io), so we need to keep the dhis2.github.io
links with this redirect intact: https://github.com/dhis2/dhis2.github.io/blob/master/redirects/dhis2_user_manual_en.md otherwise hardlinks in various versions of DHIS2 will break.
@deboragaleano has done this with dhis2/developer-portal.
I know that jekyll is the default for GH pages, and that this task will probably (and understandably) end up at the bottom of the priority list, but I find working with jekyll to be quite painful. As a team that uses almost exclusively javascript based tooling, getting a ruby based tool working properly on my system requires a ton of effort. Configuring syntax highlighting, updating dependencies, it all takes way more time than it should.
In my own experience there are plenty of viable alternatives that run exclusively on js and are better maintained and easier to work with. Should we have the time, I would love to get rid of jekyll. and think it would greatly improve maintainability of this project.