Meshcentral: @ylianst Documents can't be found there

Created on 17 Oct 2019  路  8Comments  路  Source: Ylianst/MeshCentral

@Ylianst those documents can't be found there. ;)

Fixed - Confirm & Close question

All 8 comments

I emailed @Ylianst about the source documentation for meshcentral2, he posted it to http://info.meshcentral.com/downloads/meshcentral/MeshCentralDocs.zip supposedly, but I'm unable to get these files.

The goal is to be able to post them to this GH, so the community can assist with keeping them updated, both typographically and punctually.

Apologies, here is the correct link: http://info.meshcentral.com/downloads/MeshCentral2/MeshCentralDocs.zip. This is the MeshCentral documentation in .docx format. Please enable change tracking if you make changes & corrections. Thanks.

Confirmed, that link works, out of curiosity would it be worth posting directly to this GH so the community can create edits.

Adding the documents to GitHub is a good idea. Let me see about this.

What do you think of Read the Docs?

I personally think that keeping everything to one location would be _better_. Documents can files can be uploaded to GH, they just need to be enabled.

Ok, just added a "docs" folder with all the documents on GitHub. We will see how this goes. Let me know what you mean by "just need to be enabled"?

I have not looked at Read the Docs. Could be interesting, I like that you can output many different formats. If someone has time to prototype taking one of the smallest documents and place it on Read The Docs. I would love to see what it would look like. Especially the pictures, etc. I am a bit over worked these days, I need to see if I team can get me a tech writer at some point.

I think the 'just need to be enabled' comment was regarding the way many GitHub projects use GitHub's built in Wiki function for documentation, but honestly I wouldn't recommend using that, especially considering the quality of your current documentation, as GitHub Wiki's are based on GitHub flavored MarkDown, which is missing a lot of features, most projects I know that do use them end up with broken links throughout their wiki's quickly, and they don't get versioning control.
Another option GitHub has which less projects use because the initial setup is a little more complicated than 'just enable it' is gh-pages, which is basically a second branch in your repository without any shared history, and GitHub will serve it's content to visitors at a subdomain.github.io address, there's several 'static website generators' that can be used to parse whatever you put in the gh-pages branch and turn it into a website instead of being stuck with MarkDown.

Which document would you recommend someone think about converting for a smaller, sample Read the Docs project?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

coolwormgit picture coolwormgit  路  3Comments

petervanv picture petervanv  路  3Comments

PathfinderNetworks picture PathfinderNetworks  路  3Comments

MailYouLater picture MailYouLater  路  3Comments

whalehub picture whalehub  路  3Comments