antimicrox/antimicrox.github.io

Repository containing AntiMicroX website

AntimicroX website

This is a vuepress project. checkout vuepress's docs for more info.

License

This work is licensed under the GPL v.3. Please read the LICENSE text document included with the source code if you would like to read the terms of the license. The license can also be found online at http://www.gnu.org/licenses/gpl.txt

antimicrox.github.io's Issues

Licensing

Our options for licensing are these(ordered by my liking):
1- CC-BY-SA: https://creativecommons.org/licenses/by-sa/3.0/
2- PDL: https://www.openoffice.org/licenses/PDL.html
3- GFDL: https://www.gnu.org/licenses/fdl-1.3.en.html
4- MIT

Fix problems with automatic deployment

1- I made a deploy.sh script to test deployment and it pushes to gh-pages
2- github pages branch should be set to gh-pages
3- Also I copied a github actions script. It asks for a access token that should be set. @pktiuk

rename the repo?

should we rename the repo?

my suggestions:

• website
• AntimicroX website
• AntimicroX.domain if we're ever going to buy one?

Create basic site

I think it would be good to discuss, how this site should be done both in terms of technical and in terms of content.

Technical side:

I think it would be the best solution to make this site using some kind of generator.

In my opinion the best would be combination of MkDocs with material-theme it would be deployed using GitHub actions after every push to master branch.

I think MkDocs would be suitable for us because:

• It is easy to write articles here, they can be written using regular Markdown (with additional pieces written in HTML if more flexibility would be needed)
• It has a lot of themes
• can be easily integrated with github pages
  (but this seems to be done mainly for documentation, not regular sites, I am not sure)

Content

I think this side should contain:

• as a main site it would be good to have short, visual description, what antimicrox is, how it looks etc
• some usage instructions (based on old wikis)
• Simple download and install page
• other things from legacy wiki: https://github.com/AntiMicro/antimicro/wiki https://github.com/juliagoda/antimicrox/wiki

I am open for any comments and opinions about solutions proposed above.

---

Upvote & Fund

• If you find this issue important, mark it with 👍. It lets us see which fixes and features are demanded by the most users.
• We're using Polar.sh so you can upvote and help fund this issue. It may incentivize some developers to contribute to this project and fix some bugs.
• Funded developer receives the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

The site content

List of sites which should be included into this site.
Issue for tracking them.

If there's any suggestions put in comments below.

Landing page

• Short description
• Main Features List
• CTA button: redirects to installation guide
• Some images

Installation and usage guide

Note: should use legacy wiki content.

• About AntimicroX and it's features
• Installation guide
  • Installation from different sources
  • Building guide
• TBD Usage guide
  • Command line usage guide
  • Graphical usage guide

FAQ

• FAQ page

Contribution

• Contribution guide
• How to contribute profiles

---

Upvote & Fund

• If you find this issue important, mark it with 👍. It lets us see which fixes and features are demanded by the most users.
• We're using Polar.sh so you can upvote and help fund this issue. It may incentivize some developers to contribute to this project and fix some bugs.
• Funded developer receives the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.