Abstract: Documentation on phoenicis.org

[Kreyren]

I was told that there is a documentation for phoenicis, if it's the case recommends adding it on phoenicis.org

Expected behavior

Have documentation for contribution to make installers

Actual behavior

Seeing installer as black magic and unsure what am i doing >.>

[madoar]

The documentation for Phoenicis and its scripts are hosted on the corresponding GitHub Pages:

• Phoenicis: https://phoenicisorg.github.io/phoenicis/
• Scripts: https://phoenicisorg.github.io/scripts/

It is quite easy to contribute to the documentation, because they are also hosted on github, in the docs of the corresponding repository.
To change or add something in the documentation you need to change/add the corresponding file in the docs/_docs folder, which contains the "raw" documentation in the markdown format.
After opening a PR with your changes and merging it, @PhoenicisBot will transpile the documentation from markdown to HTML and push it to the GitHub Pages for everyone to read.

About your issue (Also host the documentation on phoenicis.org):

We can think about mirroring our documentation to phoenicis.org. The problem here will be, that someone is likely required to do this manually. This can lead quite easy to an out of date documentation on phoenicis.org

[Kreyren]

@madoar Noted.

Making the contribution easier for noobs

How do i contribute to the documentation as a contributor without any knowledge in coding for example?

Afaik users are usually willing to contribute to the documentation if they find that something is missing/can be improved. Those users usually has 0 knowledge in coding..

Recommends adding a way to edit the documentation using GUI on the webside if it's github page alike

• https://docs.travis-ci.com/user/deployment/pages/ "Improve this page on GitHub".
• https://devhints.io/bash "Edit".

OR

Adding instructions to contribute to the documentation in README.

Changing the approach to render the documentation

Do we really need a bot to translate markdown into a HTML to push? Afaik we can make a website that reads markdown formatting which would also make it easier to contribute.

Alike https://devhints.io/bash

About your issue (Also host the documentation on phoenicis.org):

Same concept of https://devhints.io/bash can be applied to phoenicis assuming that both pages will be sourced from same markdown.

[plata]

There is: https://pages.github.com/

I'm not sure if it makes sense if we copy+paste the information from there.

[qparis]

This topic is not related to phoenicis I think but more about the website.
When the new website is up, we'll also have an updated version of mediawiki, which should be good enough

[Kreyren]

Let's decide based on new website then.. My suggestion in general is to make contributing to documentation easier and more effective.

[plata]

@qparis can we move this to backend?