[Howto] - Change/Update file structure of the tutorials #866

Open
opened 2024-04-07 08:52:06 +02:00 by muppeth · 7 comments
Owner

File structure in Grav is very important as it determines the navigation on the site. Depending on the proposed changes in the theme we should reorganize the file structure. The idea here is to try and find a universal file structure that could apply to all services current and future,.

File structure in Grav is very important as it determines the navigation on the site. Depending on the proposed changes in the theme we should reorganize the file structure. The idea here is to try and find a universal file structure that could apply to all services current and future,.
muppeth added the
Howto
Goal 2024
labels 2024-04-07 08:52:06 +02:00
muppeth added this to the Goal - Improve howto website project 2024-04-07 08:52:06 +02:00
muppeth added this to the 24.12 - December milestone 2024-12-01 13:19:18 +01:00
Author
Owner

now that general theme is pushed to staging, its time to work on the structure.
As requested I will deploy instance for @fede and also work on the pages structure. Once we decide on the structure we push it to staging.

now that general theme is pushed to staging, its time to work on the structure. As requested I will deploy instance for @fede and also work on the pages structure. Once we decide on the structure we push it to staging.
muppeth self-assigned this 2024-12-10 08:59:47 +01:00
fede was assigned by muppeth 2024-12-10 08:59:47 +01:00
Author
Owner

Created needed PRs. Awaiting approval and merge.

Created needed PRs. Awaiting approval and merge.
Author
Owner

Below is my proposal for file structure for new howto website. I did some modifications to the structure. I tried to streamline it and create as much unified structure as possible to handle all the services and be easy to add more tutorials for other services in the future (eg. Apps and clients section). Please have a look below. I removed some of the old clients (eg. sailfishos). I used the same name for services as we use on the website so it's easy to find things for those who are less techy. I think we should also change the order of services on the website as well and try to put most used/important apps first.

  • AccountManagement

    • Account profile
    • Creating Account
    • Change password
    • Reset password
    • Delete account
    • GDPR
      • Email export
      • Nextcloud data export
        • files
        • notes
        • calendar
      • Git export
      • Akkoma export
      • ...
  • Email

    • Server settings
    • Email Clients
      • Disroot webmail
      • Mobile Clients
        • Android
          • Fairemail
          • K9
        • iOS
      • Desktop clients
        • Thunderbird
        • Claws mail
        • Mutt
        • Emacs-Mu4e
        • Gnome
        • KDE
  • Cloud

    • Interface
    • Settings
    • Apps
      • Files
      • Calendars
      • Contacts
      • Notes
      • Talk
      • Tasks
      • Appointments
      • Deck
      • Bookmarks
      • Forms
      • Cookbook
    • Clients
      • Dekstop clients
        • Nextcloud client
        • Gnome integration
        • KDE integration
      • Mobile clients
        • Android
          • Nextcloud mobile apps
          • Davx5
        • iOS
          • File sync
          • Contacts sync
  • XMPP Chat

    • Server settings
    • Clients
      • Webchat
      • Desktop
        • Gajim
        • Dino
      • Mobile
        • Android
          • Conversations
          • Monocles
        • iOS
          • Siskin
          • Monal
    • Gateways and bridges
      • IRC
      • Matrix
  • Akkoma

    • Clients
      • Webclient
    • Mobile clients
      • Android
        • Husky
        • ???
      • iOS
        • ???
  • D-Scribe

    • Web interface
    • Clients
      • Android
        • ????
  • Cryptpad

    • Interface
    • Apps
      • Text
      • Spreadsheet
      • Code
      • Whiteboard
      • Kanban
  • Upload

  • Private Bin

  • Pads

  • Mumble

    • Clients
      • Dekstop
      • Android
      • iOS
  • Calls

    • Web interface
    • Mobile app
Below is my proposal for file structure for new howto website. I did some modifications to the structure. I tried to streamline it and create as much unified structure as possible to handle all the services and be easy to add more tutorials for other services in the future (eg. Apps and clients section). Please have a look below. I removed some of the old clients (eg. sailfishos). I used the same name for services as we use on the website so it's easy to find things for those who are less techy. I think we should also change the order of services on the website as well and try to put most used/important apps first. - **AccountManagement** - Account profile - Creating Account - Change password - Reset password - Delete account - GDPR - Email export - Nextcloud data export - files - notes - calendar - Git export - Akkoma export - ... - **Email** - Server settings - Email Clients - Disroot webmail - Mobile Clients - Android - Fairemail - K9 - iOS - Desktop clients - Thunderbird - Claws mail - Mutt - Emacs-Mu4e - Gnome - KDE - **Cloud** - Interface - Settings - Apps - Files - Calendars - Contacts - Notes - Talk - Tasks - Appointments - Deck - Bookmarks - Forms - Cookbook - Clients - Dekstop clients - Nextcloud client - Gnome integration - KDE integration - Mobile clients - Android - Nextcloud mobile apps - Davx5 - iOS - File sync - Contacts sync - **XMPP Chat** - Server settings - Clients - Webchat - Desktop - Gajim - Dino - Mobile - Android - Conversations - Monocles - iOS - Siskin - Monal - Gateways and bridges - IRC - Matrix - **Akkoma** - Clients - Webclient - Mobile clients - Android - Husky - ??? - iOS - ??? - **D-Scribe** - Web interface - Clients - Android - ???? - **Cryptpad** - Interface - Apps - Text - Spreadsheet - Code - Whiteboard - Kanban - **Upload** - **Private Bin** - **Pads** - **Mumble** - Clients - Dekstop - Android - iOS - **Calls** - Web interface - Mobile app
Owner

I still think there are a lot of clicks. For example, to get to fairemail, you'll have to click on email, then email clients, then android, then Fairemail.
Perhaps we could remove one step by removing the OS section, and add the os in the title or add a logo next to it, so for example:

  • Email
    • Clients
      • Fairemail 📱
      • K9 📱
      • iOs 📱
      • Thunderbird 🖥
        etc.
I still think there are a lot of clicks. For example, to get to fairemail, you'll have to click on email, then email clients, then android, then Fairemail. Perhaps we could remove one step by removing the OS section, and add the os in the title or add a logo next to it, so for example: - Email - Clients - Fairemail 📱 - K9 📱 - iOs 📱 - Thunderbird 🖥 etc.
Author
Owner

Yeah we could make it simplier.
I wonder if it will be universal across all other services. I think it wouldnt work on nextcloud specially when you have all the extra apps etc. but perhaps it's exeption and so should be treated that way. One thing to consider though is unlike the current theme, the new one will have a sidebar with the structure out there so I think we could make it so when you click on clients it will open the entire menu you dont have to click individually but could have direct access.

But we should test the clients part on staging to see what works best.

Yeah we could make it simplier. I wonder if it will be universal across all other services. I think it wouldnt work on nextcloud specially when you have all the extra apps etc. but perhaps it's exeption and so should be treated that way. One thing to consider though is unlike the current theme, the new one will have a sidebar with the structure out there so I think we could make it so when you click on clients it will open the entire menu you dont have to click individually but could have direct access. But we should test the clients part on staging to see what works best.
muppeth modified the milestone from 24.12 - December to 25.01 - January 2025-01-06 14:38:09 +01:00
Owner

I llike meaz's proposal. When you click on 'clients' you could have an overview page, divided into type of clients (webmail/android/ios/desktop) but in the menu you can just list the clients themsleves, making the structure a bit simpler.

I llike meaz's proposal. When you click on 'clients' you could have an overview page, divided into type of clients (webmail/android/ios/desktop) but in the menu you can just list the clients themsleves, making the structure a bit simpler.
Author
Owner

Shall we then implement it next month?

Shall we then implement it next month?
muppeth removed this from the 25.01 - January milestone 2025-02-05 07:00:15 +01:00
Sign in to join this conversation.
No milestone
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#866
No description provided.