Commit 0fa2b1b1 authored by Cassandra Gould van Praag's avatar Cassandra Gould van Praag
Browse files

merged correct syntax

parent 4aa8a609
Pipeline #10473 passed with stages
in 1 minute and 54 seconds
<!-- Note from mkdocs: "If both an indx.md and a README.md are in the same directorfy, mkdocs will render the index file" and the README will still be rendered on github (https://www.mkdocs.org/user-guide/writing-your-docs/). Adding frontmatter to README breaks it." -->
<!-- Note: Internal links to other files are relative but do not work if the file extension (e.g. ".md") is specified in the link. -->
Thank you for visiting the WIN Open Neuroimaging Community project repository.
**This is the GitHub README**
......@@ -75,7 +73,7 @@ Your name and image here!
**You**! We need people to join the community! If you would like to learn more about open research, become an [Ambassador](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/ambassadors.html) or join one of our hacks, please join the WIN Open Neuroimaging Project [mailing list](https://web.maillist.ox.ac.uk/ox/info/win-open-imaging), and stay tuned for further announcements. We will be putting out a call in the near future, with an official invitation to the community, more information about what will be involved and what is in it for you!
Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our [code of conduct](/docs/CODE_OF_CONDUCT) in all interactions both on and offline.
Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our [code of conduct](/docs/CODE_OF_CONDUCT.md) in all interactions both on and offline.
## Contact us
......
......@@ -14,27 +14,27 @@ How to contribute to this repository
---
We want to ensure that every user and contributor feels welcome and included in the WIN Open Neuroimaging community. We ask all contributors and community members to follow the [code of conduct](/community/CODE_OF_CONDUCT) in all community interactions.
We want to ensure that every user and contributor feels welcome and included in the WIN Open Neuroimaging community. We ask all contributors and community members to follow the [code of conduct](/community/CODE_OF_CONDUCT.md) in all community interactions.
**We hope that this guideline document will make it as easy as possible for you to get involved.**
Please follow these guidelines to make sure your contributions can be easily integrated in the projects. As you start contributing to the WIN Open Neuroimaging, don't forget that your ideas are more important than perfect [pull requests](https://opensource.stackexchange.com/questions/352/what-exactly-is-a-pull-request).
## 1. Contact us
In the first instance, we encourage you [connect with the Open WIN Community](contact). Let us know that you are reading the repository and you would like to contribute! You might like to introduce yourself on the #welcome channel on our [Slack workspace](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#open-win-slack-)! 👋
In the first instance, we encourage you [connect with the Open WIN Community](contact.md). Let us know that you are reading the repository and you would like to contribute! You might like to introduce yourself on the #welcome channel on our [Slack workspace](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#open-win-slack-)! 👋
## 2. Check what we're working on
You can see the things we are working on in the [Open WIN Repository Trello board](https://trello.com/b/u4FqvNJv). Have a look through and see where we have known gaps. You are also welcome to suggest any of your own improvements.
We also invite you to review our [roadmap](community/roadmap) and see how we are progressing against our community milestones.
We also invite you to review our [roadmap](community/roadmap.md) and see how we are progressing against our community milestones.
## 3. Join us at a documentation hack!
We will be holding regular "documentation hacks", where you will be guided through the process of contributing to the repository, and can participate in a git tutorial if you'd benefit from this. Take a look at our [events page](events) to find out when the next documentation hack will be held.
We will be holding regular "documentation hacks", where you will be guided through the process of contributing to the repository, and can participate in a git tutorial if you'd benefit from this. Take a look at our [events page](events.md) to find out when the next documentation hack will be held.
At the documentation hack, you will hear from members of the [Open Neuroimaging Project Working Groups](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/community/community-who/#win-open-neuroimaging-working-group) and learn about the progress of each tool. You will learn how to use each tool, be invited to contribute feedback to the tool developers, and invited to write "how to" guides to walk novice users through the process of shearing their research outputs using the [Open WIN Tools](tools).
At the documentation hack, you will hear from members of the [Open Neuroimaging Project Working Groups](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/community/community-who/#win-open-neuroimaging-working-group) and learn about the progress of each tool. You will learn how to use each tool, be invited to contribute feedback to the tool developers, and invited to write "how to" guides to walk novice users through the process of shearing their research outputs using the [Open WIN Tools](tools.md).
We will also use the documentation hacks to plan as a community, learn about what policy or guidance we need to support working open at WIN, and think about how we would like to develop. This will include community-led planning of the [Open WIN Ambassadors scheme](ambassadors).
We will also use the documentation hacks to plan as a community, learn about what policy or guidance we need to support working open at WIN, and think about how we would like to develop. This will include community-led planning of the [Open WIN Ambassadors scheme](ambassadors.md).
## Or, 4. Jump straight in!
......@@ -43,4 +43,4 @@ If you are confident using git, markdown, and github pages, you are very welcome
Coming soon
{: .label .label-yellow }
We will add git and contribution training materials after our first documentation hack, to be held in [October 2020](events/doc-hack-1)
We will add git and contribution training materials after our first documentation hack, to be held in [October 2020](events/doc-hack-1.md)
......@@ -24,6 +24,6 @@ We would like WIN Open Ambassadors to be aligned with the following activities:
- Participate in termly co-working hack days where possible
- Engage in community activities for 2-8 hours per month, in addition to the above meeting schedule
In return for their time and commitment, various [rewards and incentives](benfits) will be offered to those who become WIN Open Ambassadors.
In return for their time and commitment, various [rewards and incentives](benfits.md) will be offered to those who become WIN Open Ambassadors.
We will work to support Ambassadors in all these activities, with communication channels, training, presentation materials and defined routes of development. This support will develop as the project grows, and you will have an open invitation to suggest any additional ways we could support you in growing our community.
......@@ -81,7 +81,7 @@ Open Community
![OS-Survey 2019 slide 4](../../img/open-science-survey-results/Slide4.png)
- Appreciate the value of open sharing of code.
- Encourage the community to realise the value of sharing data within the current limits of our [open data policy](../tools/data), and equip them with the tools and knowledge to do so.
- Encourage the community to realise the value of sharing data within the current limits of our [open data policy](OpenData.md), and equip them with the tools and knowledge to do so.
![OS-Survey 2019 slide 5](../../img/open-science-survey-results/Slide5.png)
......@@ -89,7 +89,7 @@ Open Community
- Devise and promote positive incentives for open research within WIN.
- Clarify and communicate legal and ethical obligations fo data sharing.
- Promote and train the community to use the newly developed WIN Open Infrastructure for sharing [data](../tools/data), [experimental tasks](../tools/tasks), [acquisition protocols](../tools/acquisition) and [analysis tools](../tools/analysis)
- Promote and train the community to use the newly developed WIN Open Infrastructure for sharing [data](OpenData.md), [experimental paradigms](OpenParadigms.md), [acquisition protocols](OpenProtocols.md) and [analysis tools](OpenTools.md)
![OS-Survey 2019 slide 6](../../img/open-science-survey-results/Slide6.png)
......
......@@ -29,7 +29,7 @@ If you are interested in learning more about open research, incorporating open r
👋 Subscribe to the [Open WIN mailing list](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#open-win-mailing-list-) to find out about events and resources as they are shared.
👋 Say "hello" on our [Slack workspace](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#open-win-slack-) to follow and contribute to discussions about the [Open WIN Tools](tools), [events](events) or plans for the community.
👋 Say "hello" on our [Slack workspace](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#open-win-slack-) to follow and contribute to discussions about the [Open WIN Tools](tools.md), [events](events.md) or plans for the community.
👋 [Comment on this GitHub repository](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#comment-on-the-github-repository-), add an issue or submit a pull request to suggest changes to this documentation.
......
......@@ -26,7 +26,7 @@ As these stages near completion, we are entering the second phase of work to bui
The WIN Open Neuroimaging Community will address the above problems by working together to:
1. Develop tools, policies and governance recommendations to promote open research practices;
2. Identify our own barriers to working open and devising strategies to remove these barriers for ourselves and others;
3. Create documentation and training materials to help others use the [Open WIN Tools](../tools);
3. Create documentation and training materials to help others use the [Open WIN Tools](../tools.md);
4. Build a community of researchers with the expertise and confidence to promote open research practices and the Open WIN Tools in our own labs and to wider audiences.
......@@ -36,4 +36,4 @@ We intend to implement these solutions through regular co-working "hacks". These
## Ambassador program
Alongside the hacks, we will develop the WIN Open Ambassadors program for launch in 2021, where motivated individuals will be supported in sharing knowledge and sign posting their peers around open research practices and how they are implemented at WIN. The Ambassadors will be significant contributors to the community, and recognised for the value of their contribution. They will be invited to shape the governance of the community, and be consulted on policies, incentives, guiding principles and reward systems which will be devised to promote uptake of open research practices at WIN.
Take a look at our drafted outline for the [Ambassadors program](../ambassadors). We would love to hear your thoughts on how it should be put together!
Take a look at our drafted outline for the [Ambassadors program](../ambassadors.md). We would love to hear your thoughts on how it should be put together!
......@@ -51,7 +51,7 @@ WIN GitLab: [@cassag](https://git.fmrib.ox.ac.uk/cassag)
This community feeds directly into the [WIN Open Neuroimaging Project](https://www.win.ox.ac.uk/open-neuroimaging/open-neuroimaging-project) and its working groups:
* [Open Acquisition](../tools/acquisition) (lead: [Stuart Clare](https://www.win.ox.ac.uk/people/stuart-clare))
* [Open Tasks](../tools/tasks) (lead: [Laurence Hunt](https://www.win.ox.ac.uk/people/laurnece-hunt))
* [Open Analysis](../tools/analysis) (lead: [Mark Jenkinson](https://www.win.ox.ac.uk/people/mark-jenkinson))
* [Open Data](../tools/data) (lead: [Clare Mackay](https://www.win.ox.ac.uk/people/clare-mackay))
* [Open Acquisition](../tools/acquisition.md) (lead: [Stuart Clare](https://www.win.ox.ac.uk/people/stuart-clare))
* [Open Tasks](../tools/tasks.md) (lead: [Laurence Hunt](https://www.win.ox.ac.uk/people/laurnece-hunt))
* [Open Analysis](../tools/analysis.md) (lead: [Mark Jenkinson](https://www.win.ox.ac.uk/people/mark-jenkinson))
* [Open Data](../tools/data.md) (lead: [Clare Mackay](https://www.win.ox.ac.uk/people/clare-mackay))
......@@ -21,4 +21,4 @@ We want this community to grow in reach and ambition. We also want individual me
To achieve individual and community growth, we are following the "Mountain of Engagement" model. This is a tool for conceptualising how people will interact with your community, and building an understanding of how different people might grow from their first interaction to taking on some form of responsibility. Not all community members will progress to leadership, but it is useful to think about what actions or events may lead people to progress.
We have used the Mountain of Engagement model to consider how our imaginary [personas](personas-and-pathways) might interact with the Open WIN community. This exercise has provided useful insight into how we can support progression for a variety of people.
We have used the Mountain of Engagement model to consider how our imaginary [personas](personas-and-pathways.md) might interact with the Open WIN community. This exercise has provided useful insight into how we can support progression for a variety of people.
......@@ -10,7 +10,7 @@ nav_order: 3
# 3.1. Pathway barriers and solutions: Educational
{: .fs-9 }
What might be the barriers to engagement for our [personas](personas-3-descriptions) and how can we address these?
What might be the barriers to engagement for our [personas](personas-3-descriptions.md) and how can we address these?
{: .fs-6 .fw-300 }
---
......
......@@ -10,7 +10,7 @@ nav_order: 4
# 3.2. Pathway barriers and solutions: Experiential
{: .fs-9 }
What might be the barriers to engagement for our [personas](personas-3-descriptions) and how can we address these?
What might be the barriers to engagement for our [personas](personas-3-descriptions.md) and how can we address these?
{: .fs-6 .fw-300 }
---
......
......@@ -10,7 +10,7 @@ nav_order: 5
# 3.3. Pathway barriers and solutions: Welcoming and Inclusivity
{: .fs-9 }
What might be the barriers to engagement for our [personas](personas-3-descriptions) and how can we address these?
What might be the barriers to engagement for our [personas](personas-3-descriptions.md) and how can we address these?
{: .fs-6 .fw-300 }
---
......
......@@ -10,7 +10,7 @@ nav_order: 6
# 3.4. Pathway barriers and solutions: Motivational
{: .fs-9 }
What might be the barriers to engagement for our [personas](personas-3-descriptions) and how can we address these?
What might be the barriers to engagement for our [personas](personas-3-descriptions.md) and how can we address these?
{: .fs-6 .fw-300 }
---
......
......@@ -10,14 +10,14 @@ nav_order: 7
# 4.0. Persona and pathway descriptions
{: .fs-9 }
What imaginary characters can we create based on our descriptions of [who we need](personas-1-who) and [how they are motivated](personas-2-motivations) and how will they journey through this project?
What imaginary characters can we create based on our descriptions of [who we need](personas-1-who.md) and [how they are motivated](personas-2-motivations.md) and how will they journey through this project?
{: .fs-6 .fw-300 }
---
For each of our personas, we have imagined how they might interact with the project. Our consideration of barriers to participation ([educational](pathways-1-barriers-and-solutions-educational), [experiential](pathways-1-barriers-and-solutions-experiential), [inclusivity](pathways-1-barriers-and-solutions-inclusivity) and [motivational](pathways-1-barriers-and-solutions-motivational)) should have caught any potential sticking points in their progression.
For each of our personas, we have imagined how they might interact with the project. Our consideration of barriers to participation ([educational](pathways-1-barriers-and-solutions-educational.md), [experiential](pathways-1-barriers-and-solutions-experiential.md), [inclusivity](pathways-1-barriers-and-solutions-inclusivity.md) and [motivational](pathways-1-barriers-and-solutions-motivational.md)) should have caught any potential sticking points in their progression.
For each persona we will model their path through the [mountain of engagement](mountain-of-engagement).
For each persona we will model their path through the [mountain of engagement](mountain-of-engagement.md).
**Jump to one of the personas below to see how these people could be developed to leadership roles in our community, or read through all the examples!**
* [Jesse - Enthusiastic Masters student with no preconceptions of open research](#jesse)
......
......@@ -16,7 +16,7 @@ Who will our Community Members be, how will they find us and how will we support
This exercise helped us to think about who might be interested in joining our community, how we can connect with them, and the journey they might go on. It is designed to help us reach different audiences and be welcoming to diverse contributors.
**Follow the sections linked in the side bar to walk through the exercise and understand how we arrived at our [persona descriptions and described their pathways](personas-and-pathways-descriptions) to engagement with this community.**
**Follow the sections linked in the side bar to walk through the exercise and understand how we arrived at our [persona descriptions and described their pathways](personas-and-pathways-descriptions.md) to engagement with this community.**
Our intention is to update this document as we gain a clearer idea of who we are engaging with or missing from the community. Please contact us if any of the ideas presented here do not resonate with you, or if they hit the right note! 🎶
......
......@@ -44,15 +44,15 @@ Complete 🥳
#### Tasks completed
- [x] [Project vision](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/open-leadership/#vision-statement)
- [x] [Lean canvas: One page business plan describing how you will execute your vision](../open-leadership)
- [x] [Project landing page or README](../../index)
- [x] [Roadmap for identifying milestones in the project](roadmap)
- [x] [Personas and pathways: Understanding who you contributors are](personas)
- [x] [Mountain of engagement](mountain-of-engagement)
- [x] [Participation guidelines](CODE_OF_CONDUCT)
- [x] [Contributor guidelines](../../CONTRIBUTING)
- [x] [License and citation guidelines](../../LICENSE)
- [x] [Publish repository openly](../../index)
- [x] [Lean canvas: One page business plan describing how you will execute your vision](open-leadership.md)
- [x] [Project landing page or README](../../index.md)
- [x] [Roadmap for identifying milestones in the project](roadmap.md)
- [x] [Personas and pathways: Understanding who you contributors are](personas.md)
- [x] [Mountain of engagement](mountain-of-engagement.md)
- [x] [Participation guidelines](CODE_OF_CONDUCT.md)
- [x] [Contributor guidelines](../../CONTRIBUTING.md)
- [x] [License and citation guidelines](../../LICENSE.md)
- [x] [Publish repository openly](../../index.md)
#### Due date
End of August 2020
......@@ -104,7 +104,7 @@ Complete
#### Tasks completed
- [x] Action feedback from external presentation
- [x] Prepare talk (30 minutes)
- [x] [Define and document routes for interested WIN members to engage](../../contact)
- [x] [Define and document routes for interested WIN members to engage](../../contact.md)
- [x] [Set up and communicate slack](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/#open-win-slack-)
- [x] Advertise date for hack-day
......@@ -132,14 +132,14 @@ Launch 1st October 2020; Close 30th October 2020 (TBC); Analyse and report 7th N
### Milestone 6: First community hack day
#### Description
Hold first [co-working documentation hack day](../events/doc-hack-1). Involve soft launch researchers and other interested parties in designing programming and evaluation.
Hold first [co-working documentation hack day](../events/doc-hack-1.md). Involve soft launch researchers and other interested parties in designing programming and evaluation.
#### Status
Complete
#### Tasks completed
- [x] Complete Mozilla events exercise and review [CSCCE resources](https://www.cscce.org/resources/organizing-community-events/)
- [x] [Draft program](../events/doc-hack-1)
- [x] [Draft program](../events/doc-hack-1.md)
- [x] Invite speakers and check availability
- [x] Set date
- [x] Technology choices
......
......@@ -16,7 +16,7 @@ Connect with us via any of the means below as per your preference and interests
## Open WIN Slack ![slack](../img/icon-slack.png)
Anyone affiliated with a WIN member Department is invited to [join our Slack workspace](https://join.slack.com/t/openwin/signup). We have channels dedicated to each of the [sharing tools](tools), the [Open WIN community](community), and relevant external and internal [events](events).
Anyone affiliated with a WIN member Department is invited to [join our Slack workspace](https://join.slack.com/t/openwin/signup). We have channels dedicated to each of the [sharing tools](tools.md), the [Open WIN community](community.md), and relevant external and internal [events](events.md).
**Slack is where the conversation will be most active and we will share resources with each other. If you're new to the Community, this should be your first contact point!**
......
......@@ -20,7 +20,7 @@ Find out what happened on our first hack day!
The aims for the hack day were to:
1. Introduce interested individuals to the community, and communicate how you may benefit from participation, what kind of activities you may be able to take part in, how you will be recognised for your contribution, and what behaviours or commitment may be expected of you.
2. Provide training on how to use the [Open WIN Tools](../tools).
2. Provide training on how to use the [Open WIN Tools](../tools.md).
3. Provide training on GitHub/GitLab and how it will be used to update this repository.
4. Begin crafting and contributing documentation to share our training with others.
......
......@@ -25,7 +25,7 @@ The event will be hosted via [Wonder](https://www.wonder.me) at [tinyurl.com/Ope
The aim for the hack day is to:
1. Introduce interested individuals to the community, and communicate how you may benefit from participation, what kind of activities you may be able to take part in, how you will be recognised for your contribution, and what behaviours or commitment may be expected of you.
2. Provide training on how to use the [Open WIN Tools](../tools).
2. Provide training on how to use the [Open WIN Tools](../tools.md).
3. Provide training on GitHub/GitLab and how it will be used to update this repository.
4. Begin crafting and contributing documentation to share our training with others.
......
......@@ -51,7 +51,7 @@ We are working open as this is an effective way to develop a user focused and in
### Open Canvas
The open canvas is designed to help define project goals, strategy and resource needs to create a minimum viable product (MVP). The images below describe the sections for the open canvas and the model we have drafted for the future [Open WIN Ambassadors](ambassadors) program.
The open canvas is designed to help define project goals, strategy and resource needs to create a minimum viable product (MVP). The images below describe the sections for the open canvas and the model we have drafted for the future [Open WIN Ambassadors](ambassadors.md) program.
![Open canvas section descriptions](../img/mozilla-framework/open-canvas-instruc.png)
......@@ -65,37 +65,37 @@ The open canvas is designed to help define project goals, strategy and resource
A project README is your welcome mat. It should set the tone for the project, clearly describe the motivations and orient potential contributors.
The README for the Open WIN Community is the [home page of this repository](../index).
The README for the Open WIN Community is the [home page of this repository](../index.md).
### Project Roadmap
The roadmap outlines the plan for work ahead and should be shared openly with potential contributors. It summarises your vision and timeline for tasks. It is shared so people can see your progress along with the path you intend to travel. Openness here fosters trust and demonstrates an intention to involve your community in your activities.
Take a look at our [roadmap for the community](community/roadmap).
Take a look at our [roadmap for the community](community/roadmap.md).
### Personas and pathways
This exercise helps you think about the different people who will engage with the project, how they will find you, and how you will help to develop them into sustained contributors and future leaders of the project.
Take a look at our [personas and pathways analysis for the community](community/personas-and-pathways).
Take a look at our [personas and pathways analysis for the community](community/personas-and-pathways.md).
### Code of conduct
This sets out how we will interact with each other when working on this project, and how we will report and take appropriate actions against violations of this code of conduct
Take a look at our [participation guidelines](community/CODE_OF_CONDUCT) and how we will support enacting University wide policies on harassment
Take a look at our [participation guidelines](community/CODE_OF_CONDUCT.md) and how we will support enacting University wide policies on harassment
### Contributor guidelines
This describes how you can engage with the project, both as a one-time contributor or sustained participant.
Take a look at our [contributing guidelines](CONTRIBUTING).
Take a look at our [contributing guidelines](CONTRIBUTING.md).
### License and citing the repository
We would love for others to use, share and reference this repository and the materials contained within. We have applied a CC-BY 4.0 licence so you can share and adapt the materials here as long as attribution is given to this project.
Take a look at our [license and citation guidelines](LICENSE).
Take a look at our [license and citation guidelines](LICENSE.md).
### Publish your project openly
......
......@@ -35,7 +35,7 @@ Coming soon
## For WIN members
### Benefits
#### Version control ![version-control](../../img/icon-version-control.png)
The acquisition database is version controlled, so WIN members are invited to upload their protocols during pilotting to keep track of optimisation and final versions. Comments and notes can be added to each entry to you can keep well structured documentation about why certain decisions were made. You can also link database entries with acquired data held on the [Open Data](data) server
The acquisition database is version controlled, so WIN members are invited to upload their protocols during pilotting to keep track of optimisation and final versions. Comments and notes can be added to each entry to you can keep well structured documentation about why certain decisions were made. You can also link database entries with acquired data held on the [Open Data](data.md) server
#### Citable research output ![doi](../../img/icon-doi.png)
Versions (with minor and major edits) can be assigned a digital object identified (DOI) using the [Oxford Research Archive (ORA) Data repository](https://deposit.ora.ox.ac.uk) using the stable link provided by the acquisition database. Once a DOI has been created, your acquisition protocol becomes a citable object which you can add to your list of research outputs.
......@@ -55,7 +55,7 @@ Access the [Open Acquisition Database](https://open.win.ox.ac.uk/protocols/) (re
Coming soon
{: .label .label-yellow }
Detailed guidance on how to use the Open Acquisition database will be produced during one of our [documentation hacks](../events/doc-hack-1)
Detailed guidance on how to use the Open Acquisition database will be produced during one of our [documentation hacks](../events/doc-hack-1.md)
## Working group members (alphabetically)
We are grateful to the following WIN members for their contributions to developing the Open Acquisition database
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment