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 Accessible Documentation guide #232

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

isabela-pf
Copy link

This PR

  • Creates a Documentation Guide section on the home page
  • Creates a directory for documentation topics
  • Creates the Accessible Documentation within the directory

I had originally been writing an accessible documentation guide for another repository, but @trallard asked me to open the PR here after discussion with some members of this community. I have not contributed directly to learn.scientific-python.org before so I gave my best guess as to where this guide fits within existing structure; if there's a better location I'd be happy to move it.

Thank you in advance for feedback. Let me know if you have any questions! 🌻

Many thanks to @melissawm for feedback on previous drafts!

Copy link

netlify bot commented Mar 4, 2025

Deploy Preview for learn-scientific-python-org failed.

Built without sensitive environment variables

Name Link
🔨 Latest commit 07af4fb
🔍 Latest deploy log https://app.netlify.com/sites/learn-scientific-python-org/deploys/67c6491498654200084ef750

@isabela-pf
Copy link
Author

Checking in to ask if there's someone I should tag for review on this. I'm not familiar with who is looking out for the Learn work in particular.

@juanis2112
Copy link
Member

@isabela-pf Thanks for working on this! This sounds like a great addition to our website. We are currently working on restructuring our learn site so we are figuring out where this content should go. We'll be following up on this soon. (I reached out to you on discord with more specific details about this)

@juanis2112 juanis2112 self-requested a review March 10, 2025 21:17
@trallard
Copy link

@juanis2112

We'll be following up on this soon. (I reached out to you on discord with more specific details about this)

Would it be possible to keep the discussions in this PR or include me in these, since this is part of the Scientific Python CZI grant? I checked in with @stefanv, who suggested Learn to be the best place so it would be good to keep us all in the loop.

@KirstieJane
Copy link
Member

Hi @isabela-pf and @trallard !

A quick introduction for Isabela - I'm the new executive director for the Berkeley Institute for Data Science and I'm supporting @jarrodmillman and @stefanv in their roles as scientific open source research leads within BIDS. I'm also the founder of The Turing Way and I'm super passionate about supporting diverse - and accessible - contributions to open source projects!

The reason I'm giving all of that background is that in my various conversations with Jarrod, Stéfan and @juanis2112 we're realising that there's some strategic thinking that's needed to understand and define the purpose and scope of https://learn.scientific-python.org (immediately, in the medium term and in the long term).

Would you be up for a zoom call to brainstorm these possible pathways? (And anyone who is reading along is welcome to comment and join!)

I totally recognise that this is a bit of a slow path compared to reviewing and merging the PR.... but hopefully it gets us to a strong alignment. A few considerations - but definitely not all of them - related to how discoverable the content would be here, and also what level of maintenance for the documentation is required and appropriate.

I also recognise that this is funded work and so there may be constraints on timelines for example. So please comment or ping me on discord to highlight any of those considerations 🙏

I hope this all makes sense! Please let me know where I'm missing information or misunderstanding the context 💖

@juanis2112
Copy link
Member

juanis2112 commented Mar 12, 2025

Thanks @KirstieJane

In the meantime, I have created a topic in discourse where we can start writing up some ideas and also include other people who want to be part of the conversation: https://discuss.scientific-python.org/t/restructuring-https-learn-scientific-python-org/1773

@drammock
Copy link
Member

Would you be up for a zoom call to brainstorm these possible pathways? (And anyone who is reading along is welcome to comment and join!)

please loop me in when scheduling that brainstorming session; I'll attend if I can

@sanketverma1704
Copy link
Member

Thanks for working on this, @isabela-pf!
@KirstieJane and @juanis2112, please include me in the brainstorming session.

In addition to current discussions, I'd also like to explore the scope of stuff we added via #58 (which is currently hidden on https://learn.scientific-python.org).

@melissawm
Copy link
Member

I'd love to be added to this zoom call as well, if possible ❤️

@KirstieJane
Copy link
Member

This is great.... we may have the beginnings of a training working group 😀

(I'm not committing anyone to anything - just really fab to see the interest in getting this right!)

@isabela-pf
Copy link
Author

I can be added to a Zoom call, though I think I'd need to know more about the commitment of a working group in this community since I've seen them vary so widely.

Thank you for following up! I don't expect this to be a fast review path, but I did want to make sure all my cards (documents I was looking to add) were on the table for clarity.

@munkm
Copy link
Member

munkm commented Mar 14, 2025

I'd like to join the zoom call too, if possible! Similar to Dan, I'll join if I can.

@trallard
Copy link

Thanks for following up, @KirstieJane, and leveling expectations. I would like to be added to the call and will do my best to join.

@KirstieJane
Copy link
Member

Hi everyone! Thank you for all the interest! I'm going to find a time for a call with @isabela-pf @trallard @juanis2112 and me and then post that time here for anyone to join.

If we do turn these conversations into more of a working group type call I'll do something more systematic to find a time that probably works for most if not all ❤️

@isabela-pf
Copy link
Author

Hello! Checking in since I haven't found anything on my schedule yet; is meeting still a good next step?

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.

8 participants