Cloudron Docs - Community Guides

[JLX89]

@girish @nebulon Would it be possible to add a section to the Cloudron Docs or another MKDocs instance so we can add "community" documentation and how-to guides? I have a couple I'd like to push that way.

I've got a rough example setup to show how it might be done: https://git.cloudron.io/justinlosh/cloudron-docs/-/tree/master/knowledgebase/docs/community-guides?ref_type=heads

The only downfalls I can think of at the moment are:

• Outdated Content
• Cluttering up the docs site
• Review Process (Mistakes, Incorrect Information, Guide Testing)

[robi]

That's what the "How to" posts here are for.

What might be useful is another index type page linking to all of those here.

Perhaps something like an awesome-cloudron repo on GitHub.

[JLX89]

@robi said in Cloudron Docs - Community Guides:

That's what the "How to" posts here are for.

What might be useful is another index type page linking to all of those here.

Perhaps something like an awesome-cloudron repo on GitHub.

Yeah, I agree with that -- my only thought was something solid for someone to follow rather than sifting through forum topics, a bit more straight forward.

[girish]

@JLX89 You can contribute it to the main Guides section at https://git.cloudron.io/cloudron/docs/-/tree/master/knowledgebase/docs/guides?ref_type=heads .

This is an excellent idea though. We are looking into what might work well to have a nice catalogue of community guides. Anyone have a recommendation ? Bookstack or maybe something like xwiki seems like the closest we could find. These apps provide a "history" for each article quite nicely as well.

[JLX89]

The new version of Wiki.js would probably suite things very well. I setup the alpha version of it and it's a pretty incredible version change. You can view the "demo" and other information here: https://next.js.wiki

[girish]

@JLX89 yeah, wiki.js 3.0 looks really nice. We will probably move our docs into that when it's ready. We probably want 3.1 though because it has the approval workflow (much need to open a wiki to the public). For the moment, can you send a PR to our docs repo? Would also be good if you put your author name (if you like website or equivalent as well) into the article.

[timconsidine]

Is wiki.js 3.0 a viable consideration given it's (non-)release timescales ?
EVen more so in terms of 3.1 ?

[girish]

@timconsidine yeah, not holding our breath for it's release

[JLX89]

@timconsidine Yeah, I think it's been going for a bit, maybe 2021? I've tested the alpha version and to my surprise it's pretty stable, but of course they keep pushing new features. IIRC Passkeys was the last addition.

I'm planning on using it for another project and wanted to experiment with it and get something usable -- so I can work through some thoughts and ideas.

It's my first time trying to package something and I hit a problem, trying to work through it -- something permissions related with start.sh. But I'm trying to use the older Wiki.js package and port over Wiki.js 3 to see if I can get something working to play around with. If you're curious, you can take a look here.

@girish said in Cloudron Docs - Community Guides:
I submitted a PR, I'll probably work through cleaning things up and have a few other items I might be able to push in the near future. Let me know if I did that correctly -- or if I need to change anything with the PR.

[girish]

@JLX89 thank you so much! will take a look today/tomorrow.

[JLX89]

@girish Sounds good, I just pushed a few other commits but can't create another merge since I have one pending it seems. But some other thoughts and pushed some "proposals" as {placeholders} and some other documentation, you can view here.

[girish]

@JLX89 Thanks, I have merged the docs as-is, will fix up a few things. Feel free to submit other docs.

[girish]

@JLX89 I simplified the structure . Just put the new docs into guides/community for now. I have also linked them up from the parent docs. For example, Firefly-III app section will link to all the related guides.

[JLX89]

@girish Awesome, thank you! I'll fork the changes and have some items as drafts and will submit a PR when I get them updated.