Question: Documenting Public Lab projects on Github

kgradow1 is asking a question about general: Follow this topic

by kgradow1 | July 14, 2020 18:17 | #24152


Hi all, my name is Katie. I'm the Community Tech Fellow working on the bucket monitor project for Public Lab. I'm circling back with some procedural questions on open hardware documentation!

As we move forward on the first draft of a project build, I am doing some background work on best practices for open hardware documentation. I'd like to post plans for this project on Github, as well as OSHWA, but I'm not sure how best to affiliate them with Public Lab.

For github specifically, is there a way to tag or link projects to Public Lab, or should I just post under my own account and reference in a link?

Is it appropriate to cross-post documentation on github if there's no software component?

I'm not quite to the point of posting anything yet, just scoping out the territory.

Thanks in advance!

Katie



2 Comments

I think this is sort of analogous to how Summer of Code projects are posted and documented.

Reply to this comment...


Hi Katie! we'd be happy to make you a repository for these. See some example here:

https://github.com/publiclab/community-microscope

https://github.com/publiclab/papercraft-spectrometer/

if that's the route you want to go!

On Tue, Jul 14, 2020 at 2:18 PM \<notifications@publiclab.org> wrote:

Public Lab contributor kgradow1 just posted a new research note entitled ' Documenting Public Lab projects on Github':

Read and respond to the post here: https://publiclab.org/notes/kgradow1/07-14-2020/documenting-public-lab-projects-on-github


Hi all, my name is Katie. I'm the Community Tech Fellow working on the bucket monitor project for Public Lab. I'm circling back with some procedural questions on open hardware documentation!

As we move forward on the first draft of a project build, I am doing some background work on best practices for open hardware documentation. I'd like to post plans for this project on Github, as well as OSHWA, but I'm not sure how best to affiliate them with Public Lab. For github specifically, is there a way to tag or link projects to Public Lab, or should I just post under my own account and reference in a link? I'm not quite to the point of posting anything yet, just scoping out the territory.

Thanks in advance!

Katie


You received this email because you are subscribed to some or all of the following tags: .

Subscribe to all the tags for this post by visiting https://publiclab.org/subscribe/multiple/tag/.

To change your preferences, please visit https://publiclab.org/subscriptions.

Report spam and abuse to: moderators@publiclab.org

Check out the blog at https://publiclab.org/blog | Love our work? Become a Public Lab Sustaining Member today at https://publiclab.org/donate If this email title has an ID in the format #0000, you can reply with the email you use at PublicLab.org and your response will be posted as a comment on the website.

Is this a question? Click here to post it to the Questions page.

Reply to this comment...


Log in to comment