Difference between revisions of "Proposal for changes to wiki"
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [ | + | <p>The purpose of this document is to outline an alternative structure for the basis of the wiki. After not being involved with the project in any depth in over 12 months it was difficult to negotiate the various parts to the documentation. Whilst there is probably enough information to develop a ground station, the information required is in various places and has a number of obsolete components that affect the experience.</p> |
| + | <p> </p> | ||
| + | <p>The proposal is to reduce the overall quantity of documentation and place much of the detail within the wiki. This has 2 significant advantages, firstly a single source of documents and secondly the ability for changes to affected quickly (and verified) if / when there significant developments.</p> | ||
| + | <p> </p> | ||
| + | <p>The wiki currently has a structure that has a good structure. A slight change will, in my opinion, give us a better basis to work from. The structure is proposed to be changes as per figure 1 below</p> | ||
| + | [[File:SatNOGS Wiki Documentation.png]] | ||
| + | <p> </p> | ||
| + | <p><strong>Figure 1 - proposed starting layout</strong></p> | ||
| + | <p><strong> </strong></p> | ||
| + | <h1>Main Page</h1> | ||
| + | <p>The current front page with obvious links is fit for purpose. Therefore, no significant difference is proposed. A change to the linking will be required to align to the proposed structure. Other changes such as including mechanical drawings of the rotator and other visual improvements will not harm but are not crucial for now.</p> | ||
| + | <h1>Purpose</h1> | ||
| + | <p>A new page to explain what SatNOGS is and how it fits in with the overall Libre Space organisation. Some detail on the Hackaday prize and some history / development of mechanical and web stuff.</p> | ||
| + | <p> </p> | ||
| + | <p><em> Libre Space</em></p> | ||
| + | <ul> | ||
| + | <li>What is libre space?</li> | ||
| + | <li>Why are they doing it?</li> | ||
| + | <li>How does SatNOGS fit in?</li> | ||
| + | </ul> | ||
| + | <p><em>Academic research</em> – current page with links could be consolidated into a section</p> | ||
| + | <ul> | ||
| + | <li>Links as before but with a more appropriate referencing (Harvard?)</li> | ||
| + | </ul> | ||
| + | <h1>Build</h1> | ||
| + | <p><em> Software</em></p> | ||
| + | <p> <em>Database</em></p> | ||
| + | <ul> | ||
| + | <ul> | ||
| + | <li>Explain the database and where it gets it data from</li> | ||
| + | <li>Contributing – how to do it and what needs doing</li> | ||
| + | <li>API – what it does and doesn’t provide</li> | ||
| + | <li>Installation</li> | ||
| + | </ul> | ||
| + | </ul> | ||
| + | <p> <em>Client</em></p> | ||
| + | <ul> | ||
| + | <ul> | ||
| + | <li>Preferred platform – RPi 3</li> | ||
| + | <li>Image</li> | ||
| + | <li>Installation</li> | ||
| + | <li>Initial setup</li> | ||
| + | <li>Updating</li> | ||
| + | <li>Testing</li> | ||
| + | </ul> | ||
| + | </ul> | ||
| + | <p><em> Hardware</em></p> | ||
| + | <p> <em>Antennas</em></p> | ||
| + | <ul> | ||
| + | <ul> | ||
| + | <li>Type – helical vs yagi vs turnstile etc – some basic antenna theory</li> | ||
| + | <li>Helical design –explaining RHCP & LHCP / refer out to Wikipedia pages</li> | ||
| + | <li>Yagi design – as above</li> | ||
| + | <li>Turnstile design – as above</li> | ||
| + | </ul> | ||
| + | </ul> | ||
| + | <p> <em>Electronics</em></p> | ||
| + | <ul> | ||
| + | <ul> | ||
| + | <li>PCB – fabrication and population</li> | ||
| + | <li>SDR – RTL dongles, Pluto SDR, SDR play i.e. what hardware works and what doesn’t</li> | ||
| + | </ul> | ||
| + | </ul> | ||
| + | <p> <em>Rotator</em></p> | ||
| + | <ul> | ||
| + | <ul> | ||
| + | <li>Basis of design</li> | ||
| + | <li>Parts make / buy</li> | ||
| + | <li>Mechanical assembly</li> | ||
| + | <li>Final assembly and offline testing (Generally referred to as setting to work – i.e. a script to test system. Travel , limits etc)</li> | ||
| + | <li>Online testing</li> | ||
| + | </ul> | ||
| + | </ul> | ||
| + | <h1>Operate</h1> | ||
| + | <p><em> Development environment</em></p> | ||
| + | <p> Scheduling and verifying observation</p> | ||
| + | <ul> | ||
| + | <li>Current page is great, may benefit from a few additional images</li> | ||
| + | </ul> | ||
| + | <p><em> Production environment</em></p> | ||
| + | <ul> | ||
| + | <li>Moving from a development to a production ground station</li> | ||
| + | </ul> | ||
| + | <h1>Support</h1> | ||
| + | <p><em> Troubleshooting</em></p> | ||
| + | <ul> | ||
| + | <li>Common assembly issues</li> | ||
| + | <li>Common client issues</li> | ||
| + | <li>Common observation issues</li> | ||
| + | </ul> | ||
| + | <p><em>Other places for help</em></p> | ||
| + | <ul> | ||
| + | <li>Community</li> | ||
| + | <li>Matrix</li> | ||
| + | </ul> | ||
| + | <p> </p> | ||
| + | <p>Notes:</p> | ||
| + | <ol> | ||
| + | <li>This proposal is only my opinion. Not based on much other than trying to find stuff. So no reason why alternative solutions wouldn’t be better.</li> | ||
| + | <li>This does not intend to break links or completely re-write pages, there is some good stuff in there that needs to be preserved.</li> | ||
| + | <li>I have no idea what language is used in wiki so forgive me if the terms are not correct.</li> | ||
| + | </ol> | ||
| + | <p><strong> </strong></p> | ||
| + | |||
| + | [[Category:Develop]] | ||
| + | [[Category:Infrastructure]] | ||
Latest revision as of 22:32, 19 January 2020
The purpose of this document is to outline an alternative structure for the basis of the wiki. After not being involved with the project in any depth in over 12 months it was difficult to negotiate the various parts to the documentation. Whilst there is probably enough information to develop a ground station, the information required is in various places and has a number of obsolete components that affect the experience.
The proposal is to reduce the overall quantity of documentation and place much of the detail within the wiki. This has 2 significant advantages, firstly a single source of documents and secondly the ability for changes to affected quickly (and verified) if / when there significant developments.
The wiki currently has a structure that has a good structure. A slight change will, in my opinion, give us a better basis to work from. The structure is proposed to be changes as per figure 1 below
Figure 1 - proposed starting layout
Contents
Main Page
The current front page with obvious links is fit for purpose. Therefore, no significant difference is proposed. A change to the linking will be required to align to the proposed structure. Other changes such as including mechanical drawings of the rotator and other visual improvements will not harm but are not crucial for now.
Purpose
A new page to explain what SatNOGS is and how it fits in with the overall Libre Space organisation. Some detail on the Hackaday prize and some history / development of mechanical and web stuff.
Libre Space
- What is libre space?
- Why are they doing it?
- How does SatNOGS fit in?
Academic research – current page with links could be consolidated into a section
- Links as before but with a more appropriate referencing (Harvard?)
Build
Software
Database
- Explain the database and where it gets it data from
- Contributing – how to do it and what needs doing
- API – what it does and doesn’t provide
- Installation
Client
- Preferred platform – RPi 3
- Image
- Installation
- Initial setup
- Updating
- Testing
Hardware
Antennas
- Type – helical vs yagi vs turnstile etc – some basic antenna theory
- Helical design –explaining RHCP & LHCP / refer out to Wikipedia pages
- Yagi design – as above
- Turnstile design – as above
Electronics
- PCB – fabrication and population
- SDR – RTL dongles, Pluto SDR, SDR play i.e. what hardware works and what doesn’t
Rotator
- Basis of design
- Parts make / buy
- Mechanical assembly
- Final assembly and offline testing (Generally referred to as setting to work – i.e. a script to test system. Travel , limits etc)
- Online testing
Operate
Development environment
Scheduling and verifying observation
- Current page is great, may benefit from a few additional images
Production environment
- Moving from a development to a production ground station
Support
Troubleshooting
- Common assembly issues
- Common client issues
- Common observation issues
Other places for help
- Community
- Matrix
Notes:
- This proposal is only my opinion. Not based on much other than trying to find stuff. So no reason why alternative solutions wouldn’t be better.
- This does not intend to break links or completely re-write pages, there is some good stuff in there that needs to be preserved.
- I have no idea what language is used in wiki so forgive me if the terms are not correct.
