Start Here Section of Shepard Wiki

Added by Jeremy Wright about 9 years ago

I would suggest that we add a "Start Here" section to Shepard's wiki to help people who are coming into the project with no prior knowledge about it.


Replies (17)

RE: Start Here Section of Shepard Wiki - Added by Christopher Sigman about 9 years ago

The first question that comes to mind is

What will be in 'Start Here' that isn't already in the overview?

My response to that would be something like:

Getting started with the Shepard Test Stand is easy! There are a few things you'll need to get started. If you are an educator, you might want to also look at the lesson plans provided by the Coca Cola Space Science Center <here>. The first item you'll need is a laptop with a USB port. Without this, you'll have a hard time collecting data. The second main thing you'll need is the test stand itself! Right now, you have to order the parts assemble one by yourself, but shortly we will have kits available that will have all of the components you need, making it easier to get going. The last item you'll need is the software that runs on the laptop and provides the interface with the Data AcQuisition hardware (or DAQ for short). You can download a copy of that <here>.

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

I was just looking at Shepard's "Home" wiki doc, and it looks like it would be a natural place to do this.

https://opendesignengine.net/projects/shepard-ts/wiki/Wiki

Maybe we should rename the "Home" link to "Start Here", and just add some getting started content like what Chris has written above?

RE: Start Here Section of Shepard Wiki - Added by J. Simmons about 9 years ago

thumbs up I say go for it. We may also want to look at creating paragraphs for various audiences so people can find what they need quickly and easily. Something like:



Intro

Stuff from the current wiki homepage and project overview page (keep it short) which introduces the shepard test stand for those that are new to the project.

Shepard for Teachers and Scout Leaders

This is where teacher oriented materials goes. Things like link to the curriculum, how to get the test stand, etc. Basically the stuff Chris was talking about.

Shepard for Makers

This is where maker oriented material goes. Stuff like references to our design process and documentation. Link to a mods forum. Talk about how it fits into Open Source Spaceflight...

Students

Student oriented material. Links to lessons, data processing site, instructions, etc.



Not sure if there should be a separate grouping for open source spaceflight participants or if we should all of that content in the makers category. Thoughts?

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

https://opendesignengine.net/projects/shepard-ts/wiki/Wiki

Thoughts? I'm thinking that maybe licensing should be added at the bottom.

RE: Start Here Section of Shepard Wiki - Added by J. Simmons about 9 years ago

This is a great start. I imagine we will have more info to add to each section once the curriculum comes along and there are kits to sell, etc. I made one cosmetic change just to balance out the page (moved the ToC to the right hand side so the logos at the top sit next to it instead of above/below it). We should get a CCSSC logo since they are an integral part. Oh, and we should link those images. I will do that right now.

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

I was going to ask about the CCSSC logo. I'll email the appropriate people to get that conversation started. Thanks.

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

Oh, and should the logos maybe be on the right and the TOC on the left?

RE: Start Here Section of Shepard Wiki - Added by J. Simmons about 9 years ago

I tried to get the wiki syntax to do that, but it didn't really do what I wanted. This seemed like a reasonable compromise for now.

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

I see what you mean. That's something that we may have to address in later versions of ODE.

RE: Start Here Section of Shepard Wiki - Added by Christopher Sigman about 9 years ago

One suggestion I'd make is to scale the image down to maybe half that size, and to float it to the right by inserting a > after the exclamation point right for the wiki formatting for the image. It'll make everything fit better I think.

RE: Start Here Section of Shepard Wiki - Added by J. Simmons about 9 years ago

That's a good point, Chris. I was in too much of a hurry to sort out what the problem was, but the size of those two images is probably it. Just another example of why I want image resize (auto and manual) in ODE.

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

Ok, there's a little bit of a trick to getting this to work. You have to order the images and TOC tag just right. Otherwise the images not only float right, they also float down over other content. I'm going to try to find an SVG of the Mach 30 logo to try to get the text a little more readable.

!>http://opendesignengine.net/dmsf_files/262?download=!:http://www.oshwa.org/definition/ !>http://opendesignengine.net/dmsf_files/261?download=!:http://mach30.org/

{{toc}}

RE: Start Here Section of Shepard Wiki - Added by Christopher Sigman about 9 years ago

Ha, interesting that the comment I meant to be about the image of the test stand ended up being perfect for the other ones! I'd do the same for the picture of the test stand now.

RE: Start Here Section of Shepard Wiki - Added by Jeremy Wright about 9 years ago

I put some space between the Mach 30 and OSHW logos and scaled the image of Shepard down by half.

(1-17/17)