curious.bio/myzel-akustikabsorber
curious.bio/myzel-akustikabsorber
6
0
Fork 1
Code Issues Pull requests Packages Projects 4 Releases Wiki Activity

Feedback zur Nachbesserung #89

New issue
Closed
opened 2023-01-18 13:19:45 +01:00 by swendel · 0 comments
swendel commented 2023-01-18 13:19:45 +01:00
Owner
Copy link

Feedback stand 18.01.2023

fehlende bilder

  • in einigen dokumenten fehlen noch Bilder auf die zumindest referenziert wurde

fehlende bzw. unklare lizenzinformationen

https://reuse.software/spec/

Beispiel

SPDX License Header

SPDX-FileCopyrightText: 2023 Curious Community Labs e. V.

SPDX-License-Identifier: CC-BY-4.0

Alternative

falsche okh.toml Beschreibung

Beispiel

okhv = "OKH-LOSHv1.0"
name = " myzel-akustikabsorber"
repo = "https://code.curious.bio/curious.bio/myzel-akustikabsorber/"
release = "https://code.curious.bio/curious.bio/myzel-akustikabsorber/releases"
license = "CC-BY-SA-4.0"
licensor = "Curious Community Labs e. V."
organisation = "Curious Community Labs e. V."
readme = "README.md"
documentation-language = "de"
technology-readiness-level = "OTRL-4"
documentation-readiness-level = "ODRL-3*"
source = [
  "./build/src/mech/case.fcstd",
  "./build/src/mech/case-alternative.fcstd",
  "./build/Befestigung_Paneele_OSH.FCStd"
]
bom = "./bom.csv"

fehlender "Contribution guide"

Beschreibt bitte kurz wie zu dem Projekt beigetragen werden kann und verlinkt das im okh.toml und der Readme der Startseite.

Beispiel

Contribution Guide: Akustikabsorber aus Pilzmyzelkompositmaterial

  1. Forken Sie das Projekt auf Gitea und erstellen Sie einen neuen Branch für Ihre Änderungen.
  2. Ändern Sie den Code oder die Dokumentation und testen Sie Ihre Änderungen gründlich.
  3. Erstellen Sie einen Pull Request (PR) in das originale Repository und beschreiben Sie kurz Ihre Änderungen und warum sie sinnvoll sind.
  4. Warten Sie auf Feedback von den Projekt-Maintainern. Sie können ggf. gebeten werden, weitere Änderungen vorzunehmen, bevor Ihr PR angenommen wird.
  5. Sobald Ihr PR angenommen wurde, wird Ihr Code Teil des Projekts und Sie werden als Contributor im Projekt gelistet.

Hinweis: Bitte stellen Sie sicher, dass Ihr Code den Standards des Projekts entspricht und die Lizenzbedingungen einhält, bevor Sie einen PR erstellen.

Links

fehlendes "User manual"

Beschreibt bitte kurz wie das Produkt genutzt werden soll und verlinkt das im okh.toml und der Readme der Startseite.

Einhaltung des Markdown Standards

Problem

Es kann nur einmal die Ebenen H1 '#' in einem Dokument geben. H1 ist wie bei HTML der Titel des Dokuments, alle Unterteile müssen demnach mit mindestens h2/## beschrieben werden.

Linter

mdl ist einen Linter für Markdown der euch unterstützung bieten kann. Dabei sind nicht immer alle Fehler kritish, aber zumindest sollten die Header ausgebessert werden.

mdl . | grep MD025

./mod/material_fabrication/README.md:3: MD025 Multiple top level headers in the same document
./mod/material_fabrication/README.md:7: MD025 Multiple top level headers in the same document
./mod/material_fabrication/README.md:30: MD025 Multiple top level headers in the same document
./mod/anchor/README.md:3: MD025 Multiple top level headers in the same document
./mod/anchor/README.md:5: MD025 Multiple top level headers in the same document
./mod/anchor/README.md:52: MD025 Multiple top level headers in the same document
./mod/mounting_system/README.md:3: MD025 Multiple top level headers in the same document
./mod/mounting_system/README.md:5: MD025 Multiple top level headers in the same document
./mod/mounting_system/README.md:17: MD025 Multiple top level headers in the same document
./mod/mounting_system/README.md:29: MD025 Multiple top level headers in the same document
./mod/mounting_system/README.md:38: MD025 Multiple top level headers in the same document
./mod/mounting_system/README.md:92: MD025 Multiple top level headers in the same document
./mod/mould/direct_3D_negative_mould/README.md:4: MD025 Multiple top level headers in the same document
./mod/mould/direct_3D_negative_mould/README.md:6: MD025 Multiple top level headers in the same document
./mod/mould/direct_3D_negative_mould/README.md:84: MD025 Multiple top level headers in the same document
./mod/mould/casting_from_3D_positive_mould/README.md:3: MD025 Multiple top level headers in the same document
./mod/mould/casting_from_3D_positive_mould/README.md:5: MD025 Multiple top level headers in the same document
./mod/mould/casting_from_3D_positive_mould/README.md:18: MD025 Multiple top level headers in the same document
./mod/mould/casting_from_3D_positive_mould/README.md:23: MD025 Multiple top level headers in the same document
./mod/mould/casting_from_3D_positive_mould/README.md:32: MD025 Multiple top level headers in the same document
./mod/mould/casting_from_3D_positive_mould/README.md:41: MD025 Multiple top level headers in the same document
./mod/mould/README.md:3: MD025 Multiple top level headers in the same document
./mod/mould/README.md:23: MD025 Multiple top level headers in the same document
./workshop/day_1/README.md:3: MD025 Multiple top level headers in the same document
./workshop/day_1/README.md:5: MD025 Multiple top level headers in the same document
./workshop/day_1/README.md:18: MD025 Multiple top level headers in the same document
./workshop/day_1/README.md:25: MD025 Multiple top level headers in the same document
./workshop/day_1/README.md:30: MD025 Multiple top level headers in the same document
./workshop/day_1/README.md:36: MD025 Multiple top level headers in the same document
./workshop/day_2/train_the_trainer/README.md:3: MD025 Multiple top level headers in the same document
./workshop/day_2/train_the_trainer/README.md:63: MD025 Multiple top level headers in the same document
./workshop/day_2/README.md:3: MD025 Multiple top level headers in the same document
./workshop/day_2/README.md:5: MD025 Multiple top level headers in the same document
./workshop/README.md:8: MD025 Multiple top level headers in the same document
./workshop/README.md:10: MD025 Multiple top level headers in the same document
./workshop/README.md:18: MD025 Multiple top level headers in the same document
./workshop/day_3/README.md:3: MD025 Multiple top level headers in the same document
./workshop/day_3/README.md:5: MD025 Multiple top level headers in the same document
./workshop/day_3/README.md:16: MD025 Multiple top level headers in the same document

Beispiel

# README `mod/mounting_system/`

Befestigungssystem für den Prototypen eies Akustikabsorbers aus Pilzmyzelkompositmaterial

## Gliederung

1. Einleitung
2. Benötigte Materialien
3. Benötigte Geräte
4. Herstellung
    1. Sägen der Leisten
    2. Nutfräsung
    3. Zusammenbau
    4. Befestigung an der Wand
5. Lizenz

## 1. Einleitung

Das Befestigungssystem für die Akustikabsorber lässt einen modularen Aufbau zu.
Vertikal ausgerichtete Befestigungsleitern können in definierten Abständen parallel zueinander an der Wand angebracht werden. Diese Befestigungsleitern können jeweils 1, 2 oder 3 Paneeletragen.
Durch ein Versetzen der Leitern können individuelle Gebindekombinationen erreicht werden.

In jedem Paneel befinden sich 4 Holzanker mit einstellbaren Maschinenschrauben, welche das Objekt halten. Die oberen beiden Schrauben werden in die obere Nutleiste der Befestigungsleiter eingehängt. Die unteren beiden Schrauben liegen an der unteren Abstandsleiste der Befestigungsleiter an.
Dieses flexible System lässt zu, dass einzelne Paneele um 180° rotiert oder frei ausgetauscht werden können.

![mounting_system_view](media/mounting_system_view.webp)


## 2. Benötigte Materialien

- Rechteckleiste 2,4 m x 3 cm x 1 cm, Buche, Unbehandelt (https://www.bauhaus.info/rechteckleisten/rechteckleiste/p/14608075)
- Rechteckleiste 2,4 m x 2 cm x 1 cm, Buche, Unbehandelt (https://www.bauhaus.info/rechteckleisten/rechteckleiste/p/14404774)
- Stabilit Stuhlwinkel 25 x 15 x 25 mm, Stahl, Verzinkt(https://www.bauhaus.info/stuhlwinkel-treppenwinkel/stabilit-stuhlwinkel/p/10671398)
- Spax Universalschraube
2 x 10 mm, Vollgewinde (https://www.bauhaus.info/holzschrauben-spanplattenschrauben/spax-universalschraube/p/10017969)
- Wanddübel + Befestigungsschrauben

## 3. Benötigte Geräte

- Kappsäge
- Zollstock
- Anlegewinkel
- Bleistift
- Schraubendreher
- Standbohrer mit ø 1 mm Holzbohrer

---
## 4. Herstellung

Umstellen des haupt branches auf main

  • migration zum default branch 'main'

Problem

The computer industry's use of the terms master and slave caught everyone's attention in the summer of 2020. Amid the many protests and the growing social unrest, these harmful and antiquated terms were no longer considered appropriate.

"Both Conservancy and the Git project are aware that the initial branch name, 'master,' is offensive to some people and we empathize with those hurt by the use of that term," said the Software Freedom Conservancy.

GitHub took action based on the Conservancy's suggestion and moved away from the term master when a Git repository is initialized, "We support and encourage projects to switch to branch names that are meaningful and inclusive, and we'll be adding features to Git to make it even easier to use a different default for new projects." As a result, GitHub renamed the master branch to main branch.

umziehen des repo

Sontiges

  • beschreibung oder verknüfung der fertigungsdaten in der Dokumentation (wann wird zum bespiel stl/svg/fcstd verwendet)
  • "Benötigte Geräte": meint ihr Werkzeuge?
  • anpassung bezüglich der *.vf_recipe.ttl files
  • unklare nutzung von ./build/src/elec, ./build/src/software und ./build/src/firmware
# Feedback stand 18.01.2023 ## fehlende bilder * in einigen dokumenten fehlen noch Bilder auf die zumindest referenziert wurde ## fehlende bzw. unklare lizenzinformationen <https://reuse.software/spec/> ### Beispiel #### SPDX License Header ```txt SPDX-FileCopyrightText: 2023 Curious Community Labs e. V. SPDX-License-Identifier: CC-BY-4.0 ``` #### Alternative * <https://code.curious.bio/curious.bio/planktoscope/src/branch/din_spec_3105_1/.reuse/dep5> ## falsche okh.toml Beschreibung ### Beispiel ```txt okhv = "OKH-LOSHv1.0" name = " myzel-akustikabsorber" repo = "https://code.curious.bio/curious.bio/myzel-akustikabsorber/" release = "https://code.curious.bio/curious.bio/myzel-akustikabsorber/releases" license = "CC-BY-SA-4.0" licensor = "Curious Community Labs e. V." organisation = "Curious Community Labs e. V." readme = "README.md" documentation-language = "de" technology-readiness-level = "OTRL-4" documentation-readiness-level = "ODRL-3*" source = [ "./build/src/mech/case.fcstd", "./build/src/mech/case-alternative.fcstd", "./build/Befestigung_Paneele_OSH.FCStd" ] bom = "./bom.csv" ``` ## fehlender "Contribution guide" Beschreibt bitte kurz wie zu dem Projekt beigetragen werden kann und verlinkt das im okh.toml und der Readme der Startseite. ### Beispiel Contribution Guide: Akustikabsorber aus Pilzmyzelkompositmaterial 1. Forken Sie das Projekt auf Gitea und erstellen Sie einen neuen Branch für Ihre Änderungen. 1. Ändern Sie den Code oder die Dokumentation und testen Sie Ihre Änderungen gründlich. 1. Erstellen Sie einen Pull Request (PR) in das originale Repository und beschreiben Sie kurz Ihre Änderungen und warum sie sinnvoll sind. 1. Warten Sie auf Feedback von den Projekt-Maintainern. Sie können ggf. gebeten werden, weitere Änderungen vorzunehmen, bevor Ihr PR angenommen wird. 1. Sobald Ihr PR angenommen wurde, wird Ihr Code Teil des Projekts und Sie werden als Contributor im Projekt gelistet. Hinweis: Bitte stellen Sie sicher, dass Ihr Code den Standards des Projekts entspricht und die Lizenzbedingungen einhält, bevor Sie einen PR erstellen. ### Links * https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors ## fehlendes "User manual" Beschreibt bitte kurz wie das Produkt genutzt werden soll und verlinkt das im okh.toml und der Readme der Startseite. ## Einhaltung des Markdown Standards ### Problem Es kann nur einmal die Ebenen H1 '#' in einem Dokument geben. H1 ist wie bei HTML der Titel des Dokuments, alle Unterteile müssen demnach mit mindestens h2/## beschrieben werden. ### Linter `mdl` ist einen Linter für Markdown der euch unterstützung bieten kann. Dabei sind nicht immer alle Fehler kritish, aber zumindest sollten die Header ausgebessert werden. ```sh mdl . | grep MD025 ``` ```txt ./mod/material_fabrication/README.md:3: MD025 Multiple top level headers in the same document ./mod/material_fabrication/README.md:7: MD025 Multiple top level headers in the same document ./mod/material_fabrication/README.md:30: MD025 Multiple top level headers in the same document ./mod/anchor/README.md:3: MD025 Multiple top level headers in the same document ./mod/anchor/README.md:5: MD025 Multiple top level headers in the same document ./mod/anchor/README.md:52: MD025 Multiple top level headers in the same document ./mod/mounting_system/README.md:3: MD025 Multiple top level headers in the same document ./mod/mounting_system/README.md:5: MD025 Multiple top level headers in the same document ./mod/mounting_system/README.md:17: MD025 Multiple top level headers in the same document ./mod/mounting_system/README.md:29: MD025 Multiple top level headers in the same document ./mod/mounting_system/README.md:38: MD025 Multiple top level headers in the same document ./mod/mounting_system/README.md:92: MD025 Multiple top level headers in the same document ./mod/mould/direct_3D_negative_mould/README.md:4: MD025 Multiple top level headers in the same document ./mod/mould/direct_3D_negative_mould/README.md:6: MD025 Multiple top level headers in the same document ./mod/mould/direct_3D_negative_mould/README.md:84: MD025 Multiple top level headers in the same document ./mod/mould/casting_from_3D_positive_mould/README.md:3: MD025 Multiple top level headers in the same document ./mod/mould/casting_from_3D_positive_mould/README.md:5: MD025 Multiple top level headers in the same document ./mod/mould/casting_from_3D_positive_mould/README.md:18: MD025 Multiple top level headers in the same document ./mod/mould/casting_from_3D_positive_mould/README.md:23: MD025 Multiple top level headers in the same document ./mod/mould/casting_from_3D_positive_mould/README.md:32: MD025 Multiple top level headers in the same document ./mod/mould/casting_from_3D_positive_mould/README.md:41: MD025 Multiple top level headers in the same document ./mod/mould/README.md:3: MD025 Multiple top level headers in the same document ./mod/mould/README.md:23: MD025 Multiple top level headers in the same document ./workshop/day_1/README.md:3: MD025 Multiple top level headers in the same document ./workshop/day_1/README.md:5: MD025 Multiple top level headers in the same document ./workshop/day_1/README.md:18: MD025 Multiple top level headers in the same document ./workshop/day_1/README.md:25: MD025 Multiple top level headers in the same document ./workshop/day_1/README.md:30: MD025 Multiple top level headers in the same document ./workshop/day_1/README.md:36: MD025 Multiple top level headers in the same document ./workshop/day_2/train_the_trainer/README.md:3: MD025 Multiple top level headers in the same document ./workshop/day_2/train_the_trainer/README.md:63: MD025 Multiple top level headers in the same document ./workshop/day_2/README.md:3: MD025 Multiple top level headers in the same document ./workshop/day_2/README.md:5: MD025 Multiple top level headers in the same document ./workshop/README.md:8: MD025 Multiple top level headers in the same document ./workshop/README.md:10: MD025 Multiple top level headers in the same document ./workshop/README.md:18: MD025 Multiple top level headers in the same document ./workshop/day_3/README.md:3: MD025 Multiple top level headers in the same document ./workshop/day_3/README.md:5: MD025 Multiple top level headers in the same document ./workshop/day_3/README.md:16: MD025 Multiple top level headers in the same document ``` ### Beispiel ```txt # README `mod/mounting_system/` Befestigungssystem für den Prototypen eies Akustikabsorbers aus Pilzmyzelkompositmaterial ## Gliederung 1. Einleitung 2. Benötigte Materialien 3. Benötigte Geräte 4. Herstellung 1. Sägen der Leisten 2. Nutfräsung 3. Zusammenbau 4. Befestigung an der Wand 5. Lizenz ## 1. Einleitung Das Befestigungssystem für die Akustikabsorber lässt einen modularen Aufbau zu. Vertikal ausgerichtete Befestigungsleitern können in definierten Abständen parallel zueinander an der Wand angebracht werden. Diese Befestigungsleitern können jeweils 1, 2 oder 3 Paneeletragen. Durch ein Versetzen der Leitern können individuelle Gebindekombinationen erreicht werden. In jedem Paneel befinden sich 4 Holzanker mit einstellbaren Maschinenschrauben, welche das Objekt halten. Die oberen beiden Schrauben werden in die obere Nutleiste der Befestigungsleiter eingehängt. Die unteren beiden Schrauben liegen an der unteren Abstandsleiste der Befestigungsleiter an. Dieses flexible System lässt zu, dass einzelne Paneele um 180° rotiert oder frei ausgetauscht werden können. ![mounting_system_view](media/mounting_system_view.webp) ## 2. Benötigte Materialien - Rechteckleiste 2,4 m x 3 cm x 1 cm, Buche, Unbehandelt (https://www.bauhaus.info/rechteckleisten/rechteckleiste/p/14608075) - Rechteckleiste 2,4 m x 2 cm x 1 cm, Buche, Unbehandelt (https://www.bauhaus.info/rechteckleisten/rechteckleiste/p/14404774) - Stabilit Stuhlwinkel 25 x 15 x 25 mm, Stahl, Verzinkt(https://www.bauhaus.info/stuhlwinkel-treppenwinkel/stabilit-stuhlwinkel/p/10671398) - Spax Universalschraube 2 x 10 mm, Vollgewinde (https://www.bauhaus.info/holzschrauben-spanplattenschrauben/spax-universalschraube/p/10017969) - Wanddübel + Befestigungsschrauben ## 3. Benötigte Geräte - Kappsäge - Zollstock - Anlegewinkel - Bleistift - Schraubendreher - Standbohrer mit ø 1 mm Holzbohrer --- ## 4. Herstellung ``` ## Umstellen des haupt branches auf main * migration zum default branch 'main' ### Problem The computer industry's use of the terms master and slave caught everyone's attention in the summer of 2020. Amid the many protests and the growing social unrest, these harmful and antiquated terms were no longer considered appropriate. "Both Conservancy and the Git project are aware that the initial branch name, 'master,' is offensive to some people and we empathize with those hurt by the use of that term," said the Software Freedom Conservancy. GitHub took action based on the Conservancy's suggestion and moved away from the term master when a Git repository is initialized, "We support and encourage projects to switch to branch names that are meaningful and inclusive, and we'll be adding features to Git to make it even easier to use a different default for new projects." As a result, GitHub renamed the master branch to main branch. ## umziehen des repo * von https://code.curious.bio/felix/myzel-akustikabsorber * zu https://code.curious.bio/curious.bio/myzel-akustikabsorber * siehe "Transfer Ownership" https://code.curious.bio/felix/myzel-akustikabsorber/settings ## Sontiges * beschreibung oder verknüfung der fertigungsdaten in der Dokumentation (wann wird zum bespiel stl/svg/fcstd verwendet) * "Benötigte Geräte": meint ihr Werkzeuge? * anpassung bezüglich der *.vf_recipe.ttl files * unklare nutzung von ./build/src/elec, ./build/src/software und ./build/src/firmware
thies closed this issue 2023-03-29 17:49:25 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
  
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
invalid

Something is wrong

  
question

More information is needed

  
wontfix

This won't be fixed

No labels
bug
duplicate
enhancement
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: curious.bio/myzel-akustikabsorber#89
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?