Skip to content

Added readme about github backing of CO capsules#78

Open
dougollerenshaw wants to merge 1 commit into
mainfrom
add_co_github_instructions
Open

Added readme about github backing of CO capsules#78
dougollerenshaw wants to merge 1 commit into
mainfrom
add_co_github_instructions

Conversation

@dougollerenshaw
Copy link
Copy Markdown
Contributor

@dougollerenshaw dougollerenshaw commented Apr 9, 2026

Adds a readme that describes:

  • why github backing of capsules is important
  • how to start a new capsule with github backing
  • how to migrate an existing capsule to be github backed
  • troubleshooting steps

Path to rendered markdown here: https://github.com/AllenNeuralDynamics/aind-software-docs/blob/add_co_github_instructions/docs/source/code_ocean_for_publication/github_backed_capsules.md


<img src="assets/capsule_template_screenshot.png" width="600" />

2. Under **Owner**, select **AllenNeuralDynamics**. Give the repo a name and set visibility to **Internal** or **Public**.
Copy link
Copy Markdown
Contributor

@saskiad saskiad Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd either say "set the visibility to Public" or just say "set the visbility.
Our open science policy is that we work in public repos. I'm not going to battle every internal repo right now, but I don't want to tell people to use internal when our policy is not to.


6. Paste the URL from step 2 into the **The URL for your source repository** field.
7. Enter your full Allen email address in the **Your username for your source repository** field.
8. Switch back to your Code Ocean tab. If there is a **Generate a user token** option, create a token and copy it.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we probably need a separate doc page on adding GH tokens to CO that you can point to here. I think this requires more screenshots - people who understand tokens will get it just fine, but for folks less familiar with them, this can be a hurdle. (I even have to figure out where to find the tokens in GH because it's not at all intuitive).

Although... this looks like it's going in the opposite direction - CO token to GH. Screenshots would help this

@dbirman
Copy link
Copy Markdown
Member

dbirman commented Apr 16, 2026

I suggest we link to this new CO capsule overview page from https://docs.allenneuraldynamics.org/en/latest/explore_analyze/analyze_data.html

@tmchartrand
Copy link
Copy Markdown
Member

since this has expanded a bit beyond the core github backing topic, i think we should try to merge it together with a migration of the full CO best practices doc (not the publication standards which i already have a PR for). I'll try to get that together soon.

@tmchartrand
Copy link
Copy Markdown
Member

I think there's also a general question of when to link out to the CO docs vs explain something ourselves - several parts of this are pretty well documented there, but i can also see the benefit of having it all in one place. Maybe the distinction should be that if we want a detailed how-to for a well-defined topic we document it fully here, but if it's part of a list of best practices we just link out?

@dbirman
Copy link
Copy Markdown
Member

dbirman commented Apr 17, 2026

Maybe the distinction should be that if we want a detailed how-to for a well-defined topic we document it fully here, but if it's part of a list of best practices we just link out?

I think this is a good way to split it up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants