-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Doc - New POC items completed (#71)
* docs: adding new doc foundational page. * docs: first structure nav commit * docs: proof of concept, using OneDrive to embed images. * docs: remove asset diagram
- Loading branch information
1 parent
61c7c8f
commit f9a37e0
Showing
9 changed files
with
134 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: 3D Print | ||
layout: home | ||
nav_order: 3 | ||
--- | ||
|
||
3D Parent page.. | ||
|
||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: 3d Print Base Layer Pi Side Floor | ||
layout: home | ||
parent: 3D Print | ||
nav_order: 3 | ||
--- | ||
|
||
3D Pi Side Floor.. search keyword 123 | ||
|
||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: Calibration | ||
layout: home | ||
parent: Cameras | ||
nav_order: 2 | ||
--- | ||
|
||
Camera Parent page.. | ||
|
||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Cameras | ||
layout: home | ||
nav_order: 2 | ||
--- | ||
|
||
Camera Parent page.. | ||
|
||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Terminology | ||
layout: home | ||
parent: Home | ||
nav_order: 1.2 | ||
--- | ||
|
||
### Terminology | ||
|
||
- Top Camera (Position Camera) | ||
Bottom Camera (Flight Camera) | ||
|
||
- Core Pi (aka Raspberry Pi 1, Top Pi) // Desc: Where pitrac_lm, Samba would run? | ||
Messaging Pi (aka Raspberry Pi 2, Bottom Pi) // Desc: Where ActiveMQ and Tomee would run? | ||
|
||
- Flight Camera - This is the modified camera that will be installed on the first floor of the enclosure. | ||
- This camera is attached to Core Pi. | ||
- Tee Camera - This is an unmodified camera that will be installed on the top floor of the enclosure. | ||
- This camera is installed | ||
|
||
- Tee Pi - This Raspberry Pi that is used for the shared directory--Samba Server. It is recommended that you use a faster Pi (e.g. Pi5) for this Pi. Installed on the top floor of the enclosure. | ||
- Connected to the Tee off Camera (The top floor Camera) | ||
- Flight Pi - used for messaging running ActiveMQ and Apache Tomee. Installed on the bottom floor of the enclosure. | ||
- Connected to the Flight camera (the modified camera). | ||
|
||
### PiTrac | ||
<a href="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQSr4Eu550wjRoRfLHclEgkAARA1St3Qvlx-dvPuE9Aupqc?width=1024"> | ||
<img src="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQSr4Eu550wjRoRfLHclEgkAARA1St3Qvlx-dvPuE9Aupqc?width=1024" alt="PiTrac"> | ||
</a> | ||
|
||
### Diagram | ||
<a href="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQRJJ03UsL98QbZK4ppRKmdsAQ_Gr50rl9IbFNyvEkk1Wyg?width=1030&height=894"> | ||
<img src="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQRJJ03UsL98QbZK4ppRKmdsAQ_Gr50rl9IbFNyvEkk1Wyg?width=1030&height=894" alt="PiTrac Diagram"> | ||
</a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: About this Document | ||
layout: home | ||
parent: Home | ||
nav_order: 1.1 | ||
--- | ||
|
||
### About this Document | ||
|
||
To contribute to this documentation, please visit [Github Pitrac](https://github.com/jamespilgrim/PiTrac) | ||
|
||
To quickly test your documentation locally, please take the following steps: | ||
|
||
- Become familiar with `just-the-docs` project [just-the-docs](https://github.com/just-the-docs/just-the-docs) | ||
|
||
- Run locally, which is also documented in the above point: `bundle exec jekyll serve.` Of course I am simplifying as you need to install [bundler](https://bundler.io/guides/getting_started.html). You also need to install and configure [jekyll](https://jekyllrb.com/tutorials/using-jekyll-with-bundler/) | ||
|
||
- View how this project inside `docs` is configured to get an understanding of the documentation pattern. | ||
|
||
- Finally to deploy. Create your peer-review (PR) request. Github Action workflows will automatically deploy your changes once your PR is merged. This may take about 5-8 minutes to appear. Then simply refresh. |