[2024 Project goals] - Improve howto website #783

Closed
opened 2024-02-11 12:31:57 +01:00 by meaz · 9 comments
Owner

Here is the goal:

Currently the site is hard to navigate. The idea of this goal is to improve it on all fronts. Main areas of improvement are as follows:

  • Better navigation
  • Easy way to contribute new tutorials by community
  • Easy way to provide translations
  • Better way to maintain translations

What do you think of this?
What should be done?

Here is the goal: Currently the site is hard to navigate. The idea of this goal is to improve it on all fronts. Main areas of improvement are as follows: - Better navigation - Easy way to contribute new tutorials by community - Easy way to provide translations - Better way to maintain translations What do you think of this? What should be done?
meaz added this to the 24.02 - February milestone 2024-02-11 12:31:57 +01:00
Author
Owner

Here is what muppeth said: "Howtos re-work is also very much needed as in it's current state is hard to use and contribute to." and "As for howtos, the idea discusssed in the issue #721 there was a suggestion to perhaps change the backend powering the system to something that allows easeir contribution. I think if this is something to take in consideration, this should be the priority as to not waste time on changing current theme and structure this year knowing that we might replace it all together next year. I think with well defined goal and good team effort, this could be done this year if we spread the load. At least good to start working on this."

Here is what muppeth said: "Howtos re-work is also very much needed as in it's current state is hard to use and contribute to." and "As for howtos, the idea discusssed in the issue #721 there was a suggestion to perhaps change the backend powering the system to something that allows easeir contribution. I think if this is something to take in consideration, this should be the priority as to not waste time on changing current theme and structure this year knowing that we might replace it all together next year. I think with well defined goal and good team effort, this could be done this year if we spread the load. At least good to start working on this."
Author
Owner

Ideas of tasks:

  • Rework theme
  • Improve file structure
  • Fix broken links
  • Find a smart solution for translations
Ideas of tasks: - [ ] Rework theme - [ ] Improve file structure - [ ] Fix broken links - [ ] Find a smart solution for translations
Owner

I think there are two paths depending on the choice of the first task:

  • [Decission] - Change CMS or stay with GRAV (stay with grav)
  • Improve howto file struction
  • Design theme changes
  • Implement changes to file structure
  • Implement theme changes
  • Find and fix broken links
  • Find a smart solution for translations

  • [Decision] - Change CMS or stay with GRAV (change CMS)
  • Review potential candidates for new CMS using following criteria:
    • Easy translation (eg. using transifex or alike service)
    • Easy edition and creation of tutorials (preferably WYSIWYG aproach)
    • Easy to maintain and lightweight
  • Implement new CMS for testing on staging server
  • Create theme for new howto.disroot.org site
  • Improve howto file structure
  • Migrate all tutorials
  • Find and fix broken links (website, blog posts, emails, forms, services)
  • Implement Translation service
  • Update tutorials on:
    • How to contribute to howtos
    • How to contribute to translation of the howtos
I think there are two paths depending on the choice of the first task: - [ ] [Decission] - Change CMS or stay with GRAV **(stay with grav)** - [ ] Improve howto file struction - [ ] Design theme changes - [ ] Implement changes to file structure - [ ] Implement theme changes - [ ] Find and fix broken links - [ ] Find a smart solution for translations -------- - [ ] [Decision] - Change CMS or stay with GRAV **(change CMS)** - [ ] Review potential candidates for new CMS using following criteria: - Easy translation (eg. using transifex or alike service) - Easy edition and creation of tutorials (preferably WYSIWYG aproach) - Easy to maintain and lightweight - [ ] Implement new CMS for testing on staging server - [ ] Create theme for new howto.disroot.org site - [ ] Improve howto file structure - [ ] Migrate all tutorials - [ ] Find and fix broken links (website, blog posts, emails, forms, services) - [ ] Implement Translation service - [ ] Update tutorials on: - [ ] How to contribute to howtos - [ ] How to contribute to translation of the howtos

I might be totally wrong, but I remember reading somewhere (here on git.disroot.org) about possible software alternatives for the Howto pages; but currently I can only find what @fede mentioned some hours ago on #721 – that would like to test BookStack.

From my point of view, git is not the best tool if you want to encourage other to contribute and to translate. I am thinking that some wiki software would be more suitable and I was wondering if you considered DokuWiki until now.

I might be totally wrong, but I remember reading somewhere (here on git.disroot.org) about possible software alternatives for the Howto pages; but currently I can only find what @fede mentioned some hours ago on #721 – that would like to test BookStack. From my point of view, git is not the best tool if you want to encourage other to contribute and to translate. I am thinking that some wiki software would be more suitable and I was wondering if you considered [DokuWiki](https://www.dokuwiki.org/features) until now.
Owner

@floss4good thanks. wikis are great but I do think for avarage joes and janes out there it might be also hard to find stuff. But its a good addition to the list (should maybe already make an issue about choosing the new platform). We basically look for something good looking but not too much eye candy, something that is easy to navigate but also easy to post new tutorials (no git required etc) and good translation software support so that people could easily contribute with translations.

@floss4good thanks. wikis are great but I do think for avarage joes and janes out there it might be also hard to find stuff. But its a good addition to the list (should maybe already make an issue about choosing the new platform). We basically look for something good looking but not too much eye candy, something that is easy to navigate but also easy to post new tutorials (no git required etc) and good translation software support so that people could easily contribute with translations.

You might have a point regarding how easy or not you can find something in a wiki-style website (I've briefly checked their Design Examples and they are not that promising). Anyways, the pros would be that it's easier to create content and translate pages (although a translated page might have a totally different structure and content).

Nevertheless, I can't stop asking: wouldn't it be more simple if (in most of the cases) users are pointed to read the official documentation / user manual of a provided service?!

You might have a point regarding how easy or not you can find something in a wiki-style website (I've briefly checked their [Design Examples](https://www.dokuwiki.org/design_examples) and they are not that promising). Anyways, the pros would be that it's easier to create content and translate pages (although a translated page might have a totally different structure and content). Nevertheless, I can't stop asking: wouldn't it be more simple if (in most of the cases) users are pointed to read the official documentation / user manual of a provided service?!
Owner

Nevertheless, I can't stop asking: wouldn't it be more simple if (in most of the cases) users are pointed to read the official documentation / user manual of a provided service?!

Actually not. It's one of the reason we started howto site. Very often people would be lost, start creating issues concerning their accounts on upstream's project issue boards or forums, type default example values (even example.com) etc. We wanted to put all tutorials for users in one place so it's easy to find and does not confuse people. Surely lots of people know FLOSS and the fact we use upstream sotfware but a lot of people (majority in fact) has no clue, so if suddenly they are pointed to some website (like nextcloud for example) they become confused as hell.

I have a suggestion to stay on topic here, agree to the issue list so that we can create those and proceed with discussion/work in appropriate tasks. Could rest of the @Disroot/Owners check and give their feedback (or OK) so we can create issues for the goal?

> Nevertheless, I can't stop asking: wouldn't it be more simple if (in most of the cases) users are pointed to read the official documentation / user manual of a provided service?! Actually not. It's one of the reason we started howto site. Very often people would be lost, start creating issues concerning their accounts on upstream's project issue boards or forums, type default example values (even example.com) etc. We wanted to put all tutorials for users in one place so it's easy to find and does not confuse people. Surely lots of people know FLOSS and the fact we use upstream sotfware but a lot of people (majority in fact) has no clue, so if suddenly they are pointed to some website (like nextcloud for example) they become confused as hell. I have a suggestion to stay on topic here, agree to the issue list so that we can create those and proceed with discussion/work in appropriate tasks. Could rest of the @Disroot/Owners check and give their feedback (or OK) so we can create issues for the goal?

but a lot of people (majority in fact) has no clue, so if suddenly they are pointed to some website (like nextcloud for example) they become confused as hell.

I see; sorry for asking questions without having a better insight.

> but a lot of people (majority in fact) has no clue, so if suddenly they are pointed to some website (like nextcloud for example) they become confused as hell. I see; sorry for asking questions without having a better insight.
Owner

I'm closing this issue. Because further work on the goal depends on the issue #797 I have not created any more issues. Once we decide on next step (stay with grav or move to new solution) I will add all other issues.

I'm closing this issue. Because further work on the goal depends on the issue #797 I have not created any more issues. Once we decide on next step (stay with grav or move to new solution) I will add all other issues.
Sign in to join this conversation.
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Disroot/Disroot-Project#783
No description provided.