task: Update new structure

Update new structure

Signed-off-by: Gabriel Mocanu <[email protected]>

.github/workflows/linting.yml → .github/workflows/actions.yml

@@ -1,4 +1,4 @@
-name: Linting Workflow
+name: Linter Actions Workflow
 
 on:
   pull_request:
@@ -10,25 +10,25 @@ jobs:
     name: Checkpatch
     runs-on: ubuntu-latest
     steps:
-      - name: 📥 Checkpatch
-        uses: security-summer-school/actions/checkpatch@main
+      - name: Checkpatch
+        uses: open-education-hub/actions/checkpatch@main
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   super-linter:
     name: Super Linter
     runs-on: ubuntu-latest
     steps:
-      - name: 📥 Super Linter
-        uses: security-summer-school/actions/super-linter@main
+      - name: Super Linter
+        uses: open-education-hub/actions/super-linter@main
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   spellcheck:
     name: Spellcheck
     runs-on: ubuntu-latest
     steps:
-      - name: 📥 Spellcheck
-        uses: security-summer-school/actions/spellcheck@main
+      - name: Spellcheck
+        uses: open-education-hub/actions/spellcheck@main
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deployment.yml

@@ -0,0 +1,54 @@
+name: Binary Security - Github Page
+
+on:
+  push:
+    branches:
+      - main # Set a branch to deploy
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          path: ./repo
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: ./repo
+          file: ./repo/Dockerfile
+          push: false
+          load: true
+          tags: binary-security/docusaurus:latest
+          cache-from: type=gha
+          cache-to: type=gha
+
+      - name: Load image
+        run: |
+          mkdir output
+          docker image list
+          docker run -v $GITHUB_WORKSPACE/repo:/content -v $GITHUB_WORKSPACE/output:/output binary-security/docusaurus:latest
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./output
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: "github-actions[bot]"
+          user_email: "github-actions[bot]@users.noreply.github.com"
+          publish_branch: gh-pages

.github/workflows/labeler.yml

@@ -1,8 +1,8 @@
-name: Labeler Workflow
+name: Labeler Actions Workflow
 
 on:
   schedule:
-  - cron: "0 */12 * * *"
+    - cron: "0 */12 * * *"
   workflow_dispatch:
 
 jobs:
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Labeler
-        uses: security-summer-school/actions/cron-labeler@main
+        uses: open-education-hub/actions/cron-labeler@main
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -1,10 +1,71 @@
-# Contributing to the Binary Security Track
+# Contributing
 
-We welcome contributions to the content and source code of the Binary Security Track.
-You may contribute by:
+These are recommendations when contributing to the contents of this repository.
+They consider contributions to both actual content (mostly Markdown) and support code (demo, lab activities) made via Git.
 
-- opening [issues](https://github.com/security-summer-school/binary/issues)
-- taking part in [discussions](https://github.com/security-summer-school/binary/discussions)
-- creating [pull requests](https://github.com/security-summer-school/binary/pulls) to update the content
+## First Steps
 
-Before you make any contribution, make sure it follows the [community guide](https://github.com/security-summer-school/meta/blob/master/docs/contributing.md).
+Some good first steps and best practices when using Git are explained here:
+* the Git Immersion tutorial: https://gitimmersion.com/
+* the Atlassian tutorial: https://www.atlassian.com/git/tutorials/learn-git-with-bitbucket-cloud
+* this blog post on the ROSEdu Techblog: https://techblog.rosedu.org/git-good-practices.html
+
+## Language
+
+All of our content is developed in English.
+This means we use English for content, support code, commit messages, pull requests, issues, comments, everything.
+
+## Content Writing Style
+
+This section addresses the development of session content and other Markdown files.
+
+Write each sentence on a new line.
+This way, changing one sentence only affects one line in the source code.
+
+Use the **first person plural** when writing documentation and tutorials.
+Use phrases like "we run the command / app", "we look at the source code", "we find the flag".
+
+Use the second person for challenges and other individual activities.
+Use phrases like "find the flag", "run this command", "download the tool".
+
+## Images
+
+Images and diagrams would ideally be animated on slides.
+Aim to use reveal.js features to animate drawing of diagrams.
+
+If reveal.js drawing is difficult, use [draw.io](https://app.diagrams.net/) to create diagrams.
+Ideally you would "animate" those diagrams by creating multiple incremental versions of the diagram and adding each to a slide;
+when browsing slides pieces of these diagrams will "appear" and complete the final image, rendering an animation-like effect.
+
+For text where no animation is required, use diagrams / images created with [draw.io](https://app.diagrams.net/).
+If using external images / diagram, make sure they use a CC BY-SA license and give credits (mention author and / or add link to the image source).
+
+## Issues
+
+When opening an issue, please clearly state the problem.
+Make sure it's reproducible.
+Add images if required.
+Also, if relevant, detail the environment you used (OS, software versions).
+Ideally, if the issue is something you could fix, open a pull request with the fix.
+
+## Discussions
+
+Use GitHub discussions for bringing up ideas on content, new chapters, new sections.
+Provide support to others asking questions and take part in suggestions brought by others.
+Please be civil when taking part in discussions.
+
+## Pull Requests
+
+For pull requests, please follow the [GitHub flow](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork): create a fork of the repository, create your own branch, do commits, push changes to your branch, do a pull request (PR).
+The destination branch of pull requests is the default `master` branch.
+
+Make sure each commit corresponds to **one** code / content change only.
+If there are multiple commits belonging to a given change, please squash the commits.
+
+Also make sure one pull request covers only **one** topic.
+
+Use commit messages with verbs at imperative mood: "Add README", "Update contents", "Introduce feature".
+Prefix each commit message with the chapter it belongs to: `software-stack`, `data`, `compute`, `io`, `app-interact`.
+How a good commit message should look like: https://cbea.ms/git-commit/
+
+The use of `-s` / `--signoff` when creating a commit is optional, but strongly recommended.