Cloudron makes it easy to run web apps like WordPress, Nextcloud, GitLab on your server. Find out more or install now.


  • Categories
  • Recent
  • Tags
  • Popular
  • Bookmarks
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse

Cloudron Forum

Apps | Demo | Docs | Install

Cloudron Documentation Ideas

Scheduled Pinned Locked Moved Discuss
documentationfeedbacksuggestion
13 Posts 4 Posters 99 Views
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by
    #1

    This thread is started in the hope of generating some suggestions for ways to improve Cloudron's documentation.

    One of the advantages of Cloudron is that one usually has the solution to one's difficulties already explained in the documentation. This thread's focus is how to improve the appearance and clarity of documentation. For example, some policies on how to create a "How to" example might be useful. One could add a policy that a screenshot or animated GIF of the desktop might be included. Or one might have a suggestion about which colour theme to use, such as Atom One Dark.

    If you have some ideas, please throw them into the thread.

    timconsidineT 1 Reply Last reply
    1
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by LoudLemur
    #2

    Here are some examples of colour themes for the terminal. I like these because they make it somewhat easier to determine which parts are the prompt and which are instructions etc.

    https://highlightjs.org/static/demo/

    Atom One Dark
    brave_Jvf3yRplKh.png

    16 Solarized Dark
    brave_rdr80hrmJO.png

    Monokai
    brave_5SqoKeyuwj.png

    1 Reply Last reply
    1
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by
    #3

    There are some organizations which focus on documentation:

    Docusaurus 2.0 is out today. It has been completely rewritten.
    https://docusaurus.io/docs/markdown-features/code-blocks#theming

    There is also readthedocs:
    https://docs.readthedocs.io/
    https://www.doxygen.nl/manual/faq.html

    1 Reply Last reply
    0
  • L LoudLemur referenced this topic on
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by
    #4

    Different frameworks have different appearances for their documentation. Here are some examples. I like the dark backgrounds, as they help save the planet (less power required) and also are better at night than looking at a bright white page.

    Django https://docs.djangoproject.com/en/4.2/intro/install/
    brave_zhFL9bCJBa.png

    ReactJS https://react.dev/learn
    brave_aCSrgd3WID.png

    TensorFlow https://www.tensorflow.org/tutorials/quickstart/beginner
    brave_aOlqM3Zgb5.png

    Laravel https://laravel.com/docs/10.x
    IUKTsautzs.png

    1 Reply Last reply
    0
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by
    #5

    Docusaurus has a page showcasing some beautifully made documentation sites:
    https://docusaurus.io/showcase?tags=favorite

    I browsed through some of the beautiful documentation there and found this lovely example:
    https://wiki.iota.org/tutorials/create-nft-with-wallet-lib

    brave_2BuB1PQRb4.png

    1 Reply Last reply
    0
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by
    #6

    Could we support Docusaurus as an application on Cloudron?

    https://github.com/facebook/docusaurus

    1 Reply Last reply
    0
  • L Offline
    L Offline
    LoudLemur
    wrote on last edited by LoudLemur
    #7

    There is Gitbook, too:
    https://www.gitbook.com/

    which has a gallery of sites made using Gitbook:
    https://www.gitbook.com/gitbook-library

    If you are familiar with RocketChat's or Cal.com's documentation, they are featured there.

    nebulonN 1 Reply Last reply
    0
  • timconsidineT Offline
    timconsidineT Offline
    timconsidine App Dev
    replied to LoudLemur on last edited by
    #8

    @LoudLemur how needed is this ?
    I find Cloudron documentation fine in its current form

    necrevistonnezrN L 2 Replies Last reply
    3
  • nebulonN Offline
    nebulonN Offline
    nebulon Staff
    replied to LoudLemur on last edited by
    #9

    @LoudLemur seems like gitbook is a service. Also for the organization we prefer to selfhost as much as possible.

    1 Reply Last reply
    1
  • necrevistonnezrN Offline
    necrevistonnezrN Offline
    necrevistonnezr
    replied to timconsidine on last edited by
    #10

    @timconsidine We could have avoided a whole thread about a bitwarden cli command with clearer documentation - as in, write it for someone who has never used the tool 🙂

    timconsidineT 1 Reply Last reply
    1
  • timconsidineT Offline
    timconsidineT Offline
    timconsidine App Dev
    replied to necrevistonnezr on last edited by
    #11

    @necrevistonnezr missed that one
    but isn't that a content issue rather than a platform choice?

    I don't mind about platform. Content and clarity are key.

    L 1 Reply Last reply
    0
  • L Offline
    L Offline
    LoudLemur
    replied to timconsidine on last edited by
    #12

    @timconsidine said in Cloudron Documentation Ideas:

    I don't mind about platform. Content and clarity are key.

    I think in this case, platform choices (the colour theme for the CLI on Cloudron) contributed to the problem of clarity.

    Documentation policy is also part of the platform, too. For example, one policy that might be beneficial would be to include a worked example for CLI commands. Another might be to include an animated GIF with the tutorial, as pictures tell a thousand words, can be quicker to create than typing out the documentation, and show the entire, uninterrupted flow, so nothing is overlooked in the process.

    If we start examining policy, then we might as well look at other aspects of policy too, such as making the display look ok at night, when there is low light and we don't want blue -light to disturnb our sleep cycles, etc.

    1 Reply Last reply
    0
  • L Offline
    L Offline
    LoudLemur
    replied to timconsidine on last edited by
    #13

    @timconsidine said in Cloudron Documentation Ideas:

    I find Cloudron documentation fine in its current form

    Cloudron has good quality documentation, I agree.

    1 Reply Last reply
    1

  • Login

  • Don't have an account? Register

  • Login or register to search.
  • First post
    Last post
0
  • Categories
  • Recent
  • Tags
  • Popular
  • Bookmarks
  • Login

  • Don't have an account? Register

  • Login or register to search.