Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Add onboarding documents for different roles #12

Open
3 of 6 tasks
eirini-zormpa opened this issue Aug 11, 2022 · 3 comments
Open
3 of 6 tasks

📚 Add onboarding documents for different roles #12

eirini-zormpa opened this issue Aug 11, 2022 · 3 comments
Assignees

Comments

@eirini-zormpa
Copy link
Collaborator

eirini-zormpa commented Aug 11, 2022

About

AIM is a large project and starting on it can be pretty daunting; it would be nice to have onboarding documentation for the various roles within AIM in this repo.

I think it'd be helpful to have documentation specific to the different positions people have - e.g. working for AIM vs. AIM RSF.

To-do

  • figure out how many versions of the onboarding make sense -> always have the boiler plate be the most up to date
  • figure out a way to keep the various versions synced but separate (if possible) -> have a boiler plate that gets updated and then archive the new starter files into a folder
  • create first drafts
  • get feedback from people in those positions
  • finalise the documents
  • make sure they're easy to find

Stakeholders

This is relevant for everyone working in AIM/AIM RSF with the primary contacts being EZ and SB.

Activity

EZ added some drafts to the onboarding branch (https://github.com/aim-rsf/Getting-Started/blob/onboarding-docs/onboarding/rsf-turing-staff.md) . These are based on the documentation that SB created.

@BrainonSilicon BrainonSilicon changed the title add onboarding documents for different roles 📚 Add onboarding documents for different roles Sep 27, 2022
@BrainonSilicon
Copy link
Contributor

I will move the onboarding docs @eirini-zormpa drafted out of Getting Started as the Getting Started repo was also for consortia members and not just Turing employees.

They look awesome Eirini! I'm happy to move them maybe into community management and then make a PR?

@BrainonSilicon
Copy link
Contributor

BrainonSilicon commented Oct 14, 2022

* [ ]  figure out how many versions of the onboarding make sense
* [ ]  figure out a way to keep the various versions synced but separate (if possible)

My thoughts is to have the core docs as templates, and then just a file for each person. Then what gets updated is only every the core docs and whoever the new starter's file is?

Does that make sense @eirini-zormpa ? 😶‍🌫️

@eirini-zormpa
Copy link
Collaborator Author

Oops this fell through the cracks didn't it 🙈

That should work! Though my main uncertainty was about keeping the templates synced with each other (e.g. AIM RSF at the Turing, AIM RSF outside the Turing, AIM consortium member)

BrainonSilicon added a commit that referenced this issue Oct 18, 2022
- moved onboarding files into community management repo (see #12)
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

No branches or pull requests

2 participants