From cc0d92c37f467fdac069aa1dc3685018c0a23bf4 Mon Sep 17 00:00:00 2001 From: zeus Date: Sat, 22 Aug 2020 11:15:06 +0300 Subject: [PATCH] howto --- swarmlab/main.adoc | 26 ++++++++++++++++- swarmlab/main.adoc.html | 62 +++++++++++++++++++++++++++++++++++++++-- 2 files changed, 84 insertions(+), 4 deletions(-) diff --git a/swarmlab/main.adoc b/swarmlab/main.adoc index bf0bbd1..51996db 100644 --- a/swarmlab/main.adoc +++ b/swarmlab/main.adoc @@ -522,13 +522,37 @@ Swarmlab.io is a open source project born to support interactive Virtual Labs an Swarmlab.io is open and welcoming to all. -And we need your help. +INFO: And we need your help. We invite anyone to come and participate in the creation of Swarmlab.io. Regardless of your skillset, we’re sure there is something you can add to our community and project. +=== Reporting Security Issues +The Swarmlab.io maintainers take security seriously. If you discover a security issue, please bring it to their attention right away! +IMPORTANT: Please DO NOT file a public issue, instead send your report privately to security@swarmlab.io. +Security reports are greatly appreciated and we will publicly thank you for it, although we keep your name confidential if you request it. + +=== Reporting other issues + +A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it! + +Check that our issue database doesn’t already include that problem or suggestion before submitting an issue. However, if you have ways to reproduce the issue or have additional information that may help resolving the issue, please leave a comment. + +INFO: When reporting issues, always include: as much information as you can + +Also include the steps required to reproduce the problem if possible and applicable. This information will help us review and fix your issue faster. Don’t forget to remove sensitive data from your logfiles before posting (you can replace those parts with “REDACTED”). Quick contribution tips and guidelines +contributions can make a docker-compose prototype + +=== Develop swarmlab services + +All developers already familiar with docker-compose and that have already set up interesting stacks that may be useful to others, are highly encouraged to add them to the repository and share them. Improvements on the current samples are also very much appreciated! + + +=== Create Learning Object Notebooks + +link:main,adoc.html#_create_learning_object_notebook[See here] diff --git a/swarmlab/main.adoc.html b/swarmlab/main.adoc.html index fb1e69a..9752241 100644 --- a/swarmlab/main.adoc.html +++ b/swarmlab/main.adoc.html @@ -502,7 +502,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -
  • 5. Get Involved
    • +
  • 5. Get Involved + +
    • @@ -1529,11 +1536,60 @@ Bootstraping is final and no further edits are allowed!!

    Swarmlab.io is open and welcoming to all.

    -

    And we need your help.

    +

    INFO: And we need your help.

    We invite anyone to come and participate in the creation of Swarmlab.io. Regardless of your skillset, we’re sure there is something you can add to our community and project.

    +
    +

    5.1. Reporting Security Issues

    +
    +

    The Swarmlab.io maintainers take security seriously. If you discover a security issue, please bring it to their attention right away!

    +
    +
    + + + + + +
    + + +Please DO NOT file a public issue, instead send your report privately to security@swarmlab.io. +
    +
    +
    +

    Security reports are greatly appreciated and we will publicly thank you for it, although we keep your name confidential if you request it.

    +
    +
    +
    +

    5.2. Reporting other issues

    +
    +

    A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it!

    +
    +
    +

    Check that our issue database doesn’t already include that problem or suggestion before submitting an issue. However, if you have ways to reproduce the issue or have additional information that may help resolving the issue, please leave a comment.

    +
    +
    +

    INFO: When reporting issues, always include: as much information as you can

    +
    +
    +

    Also include the steps required to reproduce the problem if possible and applicable. This information will help us review and fix your issue faster. Don’t forget to remove sensitive data from your logfiles before posting (you can replace those parts with “REDACTED”). Quick contribution tips and guidelines +contributions can make a docker-compose prototype

    +
    +
    +
    +

    5.3. Develop swarmlab services

    +
    +

    All developers already familiar with docker-compose and that have already set up interesting stacks that may be useful to others, are highly encouraged to add them to the repository and share them. Improvements on the current samples are also very much appreciated!

    +
    +
    +
    +

    5.4. Create Learning Object Notebooks

    +
    +

    See here

    +
    +
    @@ -1548,7 +1604,7 @@ Bootstraping is final and no further edits are allowed!!