Merge pull request #1 from open-make/gitb_tests

moving to gitbuilding independent, version derived from open next work, still in working state

.github/workflows/gitbuilding.yml

@@ -0,0 +1,26 @@
+
+name: Deploy Gitbuilding Project to Github Pages
+
+on: [push]
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Python 3
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.7"
+      - name: Build
+        run: |
+          pip install gitbuilding
+          gitbuilding build-html
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@3.7.1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: _site/
+          # Automatically remove deleted files from the deploy branch
+          CLEAN: true

10_Ideation/README_minimal.md

@@ -0,0 +1,32 @@
+# My research hardware project name
+
+-   development stage: idea generation <!--- needs analysis, Concept development, product development and prototyping: give version number, replicator : give version number
+        --->
+-   subject area/type of hardware
+- prerequisite: who is this documentation made for
+
+## Vision and motivation
+
+This paragraph explains the ultimate goal of the project, its specificity and main objectives.
+
+Please also indicates the problem this project aims at solving
+
+## Community and Contributions
+This section explains who is behind the project.
+
+### List of team members / contributors
+
+### Who could contribute
+
+### Communication channel, how to contribute
+
+## License and rights
+
+## Funding information
+
+-   Sponsors and funding:
+
+-   Future funding opportunities:
+
+> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template.
+> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software.

20_needs_analysis/02_product_dvt/01_hardwareoverview.md

@@ -0,0 +1,6 @@
+## requirements
+
+## constrains
+
+## capability
+

20_needs_analysis/02_product_dvt/02_user_analysis.md

@@ -0,0 +1,6 @@
+## target groups (who will use the product)
+
+
+## External interfaces (how will they use the product)
+
+## skills needed to use

20_needs_analysis/02_product_dvt/04_behavioralmodel.md

@@ -0,0 +1 @@
+## Modelling tool list

20_needs_analysis/README_needs_add.md

@@ -0,0 +1,43 @@
+# My research hardware project name
+
+-   development stage: needs analysis 
+
+
+> To Add before "## Community and Contributions"
+
+## Problem description
+
+## Roadmap
+This paragraph explains briefly the history of the project and the future milestones and time plan.
+
+### Project history summary
+
+### Future work
+
+> To Add inside "## Community and Contributions"
+
+## Community and Contributions
+
+### work culture 
+
+Summary
+
+-   [guidelines](01_community/guidelines.md)
+-   [Code of conduct](01_community/coc.md)
+
+> To Add at the end:
+
+## Administrative information
+
+-   *ethics statement (human/animal use or Informed Consent Statement)*
+-   *competing interest*
+
+## Documentation structure
+
+This readme contains the first level of information.
+in 
+- 01_community are saved our detailed documentation about the community practices
+- 02_product_dvt you will find high level analysis of the hardware design like the list or requirements and user analysis
+- 03_project_history you will find information about past decisions in the project
+
+

30_concept_dvt/02_product_dvt/01_hardwareoverview_add.md

@@ -0,0 +1,11 @@
+> add at the beginning
+
+## foreseen cost (money and time)
+
+> add at the end
+
+## use cases and application
+
+## reuse possibilities
+
+## architectural structure

30_concept_dvt/02_product_dvt/04_behavioralmodel.md

@@ -0,0 +1 @@
+## Modelling tool list

30_concept_dvt/README_concept_add.md

@@ -0,0 +1,18 @@
+# My research hardware project name
+
+- development stage: Concept development
+
+
+
+> To Add before "## Roadmap" or before "## Problem description" 
+
+## dependencies
+indicate and cite projects this project is built on
+For the software part, indicate the main component, use a dependency.txt files in the software folder when needed.
+
+##software used for development
+
+> to add at the end
+
+## conclusions
+summary of main results obtained and discussion that happened so far

Futuresteps/product-design/Product_design_main_info.md

@@ -0,0 +1,19 @@
+## Bill of material
+
+## material characteristics
+
+## electrical design
+
+## firmware/Software: Documentation of different parts
+
+## Manufacturing instructions
+
+- skills
+- tools
+- link to instructions
+
+## Assembly instructions
+
+- skills
+- tools
+- link to instructions

README.md

@@ -1,29 +1,67 @@
-# My research hardware project title
+# Vision: a template for OSH projects
 
-## Vision
+In this repository, we are building templates for elements of an open source hardware project.
+The aim is to facilitate the work of designers, helping them to easily create the documentation at the right time.
 
-This paragraph explains the ultimate goal of the project, its specificity and main objectives.
+# How to use this template
 
-## Community and authors
+This repository has one folder for each steps in the hardware projects, including elements that may or should be added to the documentation, and a checklist is provided to be able to follow the process.
+The documenter may simply start by coping the 01_ideation folder, and change content where asked.
+When finised, the documenter can go to the next step, copying files and adding elements to the readme, the checklist will help them find elements they want to add.
+It is good practice to review the documentation in the team at each step.
+One can use forks (when one is using a Git forge), if one want to go forward before the review of the team.
 
-This section explains who is behind the project.
+> *Example*: Max has a first prototype already.
+> He starts its documentation with the idea description, add the analysis of needs, then the concept development files.
+> Finally, he is adding the product documentation related to its prototype.
+> By asking for feedback along the process, Max did realize the ideation documentation is extremely helpful to present the project, especially outside his first collaborators circle and more people showed interest in the project.
+> By making some requirement more explicit, Max could derive specific needs and therefore specific hardware functionalities the first prototype is lacking, Max hopes to find better solutions in the next prototype iteration.
+> One year later, Max is leaving the project, but the project still lives as new maintainers with the same vision are developing it further.
 
-## Related projects
+# Project history and rational
 
-This section should try to summarise other projects related to the vision, why there is a need for a new project. It is recommended to invest some time in this research. You may end up joining or forking an existing project instead of creating a new one.
+Open source hardware projects documentation can be divided in at least two activities: documenting the product (manufacturing, assembly, use, maintenance and so on.) and documenting the process (project vision, collaborators, how to collaborate, design process).
+This distinction can also be linked with the five [OSHWA defined freedom for OSH](https://freedomdefined.org/OSHW): **study**, **modify** being mostly related to the process; **make**, **distribute,** and **sell** being mostly related to the product.
 
-## Communication channel
+On the other hand, an hardware project goes through several development steps, each of them deserving some specific documentation.
+In the **ideation** phase, one should define the project vision and find collaborators.
+In the **needs analysis** phase, the team is documenting their research on the definition of requirements and on the related existing projects.
+In the **concept** phase, the team is describing some implementation possibilities.
+In the **prototyping** phase, the team is iteratively designing a prototype, the product documentation is starting now, while the process documentation may be expanded as new collaborators comes in.
+In the **replicator** phase, the prototype is moved to a market-ready product, and the documentation aimed at users and producers of hardware will become more important.
 
-Describe how to connect with this project. It is recommended to use a different platform than the one where the data is to prevent vendor lock-in effects, and to find a tool already in use in your community. 
+## Growing documentation with project size
 
-Please use the issue function in this repository to contact us.
+Using analyses of at several examples of hardware and software project, we derived a large amount of elements that may be included in an hardware project.
+We then categorizing them following their goal (process or product documentation) and indicated whether it should be created or updated at different stage of development.
 
-## License and rights
+From this we created a miminal template for the ideation stage, and provide a checklist of additional elements to add.
+Templates for each additional elements are also provided.
 
-Please indicate how people will be allowed to use the information found in this repository. You may want to add a license created for open source hardware. You may get some information in the [turing way open book chapter on hardware licensing](https://book.the-turing-way.org/reproducible-research/licensing/licensing-hardware). 
+# Roadmap and future work
 
+We plan on providing template files and good guidelines in November 2024.
+Then, we plan on testing them in specific projects (internal and external).\
+In the future, we hope to build some software to help with the additions instead of using a checklist.
 
+## Community, Contributions funding
 
+This was developed inside the LAUDS Factories and the Open.Make projects, based on results of the OpenNext project.
 
-> Note: 
-> This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software.
+LAUDS Local Accessible Urban Digital Sustainable Factories is a Horizon Europe research and innovation action - Co-funded by the European Union, 2024-2026, GA 101135986
+
+OpenNext has received funding from the European Union’s Horizon 2020 research and innovation programme under [grant agreement no. 869984](https://cordis.europa.eu/project/id/869984).
+
+OpenMake is funded by the Federal Ministry of Education and Research (BMBF) and the state of Berlin under the Excellence Strategy of the Federal Government and the Länder / www.berlin-university-alliance.de
+
+## Main contributors:
+
+Julien Colomb: julien.colomb [at] fu-berlin.de
+
+Sacha Hodencq
+
+Jean-François Boujut
+
+Robert Mies
+
+Moritz Maxeiner

README_minimal.md

@@ -0,0 +1,30 @@
+# My research hardware project name
+
+-   development stage: idea generation <!--- needs analysis, Concept development, product development and prototyping: give version number, replicator : give version number
+            --->
+-   subject area/type of hardware
+
+## Vision and motivation
+
+This paragraph explains the ultimate goal of the project, its specificity and main objectives.
+
+## Community and Contributions
+
+### List of team members / contributors
+
+### Who could contribute
+
+This section explains who is behind the project.
+
+### Communication channel, how to contribute
+
+## License and rights
+
+## Funding information
+
+-   Sponsors and funding:
+
+-   Future funding opportunities:
+
+> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template.
+> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software.

RHardware-minimaltemplate.Rproj

@@ -0,0 +1,13 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX

_build/AssemblyManualSource/Parts/M4x10PanSteel.md

@@ -0,0 +1,23 @@
+# M4x10 Pan Head Steel
+
+This is lots of text about some screws?
+
+
+
+
+## Specifications
+
+|Attribute |Value|
+|---|---|
+|Head|Pan|
+|Length|10 mm|
+|Material|Stainless Steel|
+|Pitch|0.7|
+
+
+## Suppliers
+
+|Supplier |Part Number|
+|---|---|
+|RS|[528-817](https://uk.rs-online.com/web/p/machine-screws/0528817/){:target="_blank"}|
+|McMasterCarr|[90116A207](https://www.mcmaster.com/90116A207){:target="_blank"}|

_build/AssemblyManualSource/Parts/Screwdriver_Philips_No2.md

@@ -0,0 +1,12 @@
+# No. 2 Phillips screwdriver
+
+No2 Phillips screwdriver. This is the correct size form an M4 pan head screw
+
+
+
+
+## Specifications
+
+|Attribute |Value|
+|---|---|
+|Drive Size|No. 2|

_build/AssemblyManualSource/index.md

@@ -0,0 +1,14 @@
+# Test Project
+
+This is a great place to start making your documentation!
+
+You should link to a couple of pages:
+
+* [Test Page 1](testpage1.md "")
+* [Test Page 2](testpage2.md "")
+
+And you should definitely let people know about the [bill of materials](index_BOM.md) [(csv)](index_BOM.csv) page.
+
+---
+
+[Next page](index_BOM.md)

_build/AssemblyManualSource/index_BOM.csv

@@ -0,0 +1,4 @@
+Name in documentation	Qty	Full Name	Supplier 1	Part No	Link	Supplier 2	Part No	Link
+M4x10 screws	10	M4x10 Pan Head Steel	RS	528-817	https://uk.rs-online.com/web/p/machine-screws/0528817/	McMasterCarr	90116A207	https://www.mcmaster.com/90116A207
+No. 2 Phillips screwdriver	1	No. 2 Phillips screwdriver						
+widget	2	Widget	Widget Shop	Widget1	https://dictionary.cambridge.org/dictionary/english/widget			

_build/AssemblyManualSource/index_BOM.md

@@ -0,0 +1,25 @@
+# Bill of Materials
+
+Download this as a [CSV file](index_BOM.csv)
+
+
+
+### Parts
+
+* 10 [M4x10 screws]{: Class="bom"} 
+* 2 [widget]{: Class="bom"} 
+
+
+### Tools
+
+* 1 [No. 2 Phillips screwdriver]{: Class="bom"} 
+[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md ""
+[M4x10 screws]:Parts/M4x10PanSteel.md ""
+[widget]:widget.md ""
+
+
+
+
+---
+
+[Previous page](index.md) | [Next page](testpage1.md)