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 Developer Onboarding Plan and Supporting Documentation #2429

Closed
wants to merge 2 commits into from

Conversation

ashleymeigh2
Copy link
Collaborator

Issue

Closes #2408

Description

This PR adds the onboarding plan and supporting documentation to assist new developers in setting up their environment and getting familiar with the project. Key elements of the onboarding plan include:

Goals for the onboarding process.
Week-by-week overview of tasks and milestones.
Core skills development with detailed links to resources for Python, PyQt, and Neutron Imaging.
Detailed guidance on Mantid Imaging's MVP architecture.
Supporting links to external documentation and case studies.

Testing

Verified the formatting of the onboarding document in RST format.
Checked that all external links included in the documentation are functional and relevant.
Previewed the rendered documentation to ensure clarity and readability.

Acceptance Criteria

Review the added onboarding document for accuracy and completeness.

Documentation

The onboarding plan has been added to the documentation

@ashleymeigh2 ashleymeigh2 changed the title added on boarding plan Add Developer Onboarding Plan and Supporting Documentation Dec 9, 2024
Copy link
Collaborator

@samtygier-stfc samtygier-stfc left a comment

Choose a reason for hiding this comment

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

I don't think the onboarding plan needs to be in the docs, as it varies by the needs/experience of the developer.
But the list of resources is useful, so lets keep that.

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.

Add New Starter Section to Documentation
3 participants