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

[Project] Improve Bokeh's documentation using the Diátaxis framework #1

Open
pavithraes opened this issue Feb 24, 2023 · 9 comments
Open
Labels
outreachy-may-2023 Internship projects for Outreachy's May 2023 round

Comments

@pavithraes
Copy link
Member

pavithraes commented Feb 24, 2023

Bokeh's documentation grew organically for many years. In the past couple of years, we restructured, re-designed, and improved it significantly. We'd like to continue improving the documentation using some principles from the Diátaxis (https://diataxis.fr/) framework. Diátaxis has been used successfully to improve many project documentations, including projects in the Python data science ecosystem that Bokeh is a part of.

This internship project will involve reviewing Bokeh's documentation (primarily the user guide), and restructuring and updating the documentation pages to use principles defined by the Diátaxis framework.

Preliminary reading

  1. Learn basics of Bokeh with these first steps
  2. Familiarize yourself with the Diátaxis framework for documentation

Micro tasks for the contribution phase

  1. (Required) [Micro task] Set up your local development environment for Bokeh #4
  2. (Required) [Micro task] Work on "Add metadata to standalone examples" #5
  3. (Optional) Work on any documentation task from Bokeh issues tracker
@pavithraes pavithraes added the outreachy-may-2023 Internship projects for Outreachy's May 2023 round label Feb 24, 2023
@pavithraes pavithraes changed the title Improve Bokeh's documentation using the Diátaxis framework [Project] Improve Bokeh's documentation using the Diátaxis framework Feb 24, 2023
@Soot3
Copy link

Soot3 commented Mar 6, 2023

Good day, outreachy applicant here. I have experience working with Python for data visualizations. I have used Bokeh before and have some articles around/using data visualization.
https://ikigailabs.medium.com/8-tips-for-creating-engaging-data-visualizations-6d26c2e0b408
https://sootersaalu.medium.com/

I haven't received the slack invite yet but I would love to work on this task or the other article focused task.

Thank you!

@Med16-11
Copy link

Med16-11 commented Mar 7, 2023

Hello @pavithraes !
I am an Outreachy applicant from India and I would like to work on this project. I am currently waiting for slack invite but I am starting contribution from today.
Thank you.

@pavithraes
Copy link
Member Author

Welcome! I see you're both on Slack now. Let me know if you have any questions, and I look forward to your contributions. :)

@robinokwanma
Copy link

Hi, @pavithraes i would also love to work on this as soon as possible, i am an outreachy applicant. Can i get the slack invite also?

@peter-abel
Copy link

Hi everyone, for outreachy here.

@KASHISH17RAMANI
Copy link

Hi, @kashish ramani i would also love to work on this as soon as possible, i am an outreachy applicant. Can i get the slack invite also?

@satyamksharma
Copy link

Hi there, I'm an outreachy applicant and would love to contribute. Can I be assigned to this issue?

@pavithraes
Copy link
Member Author

Welcome everyone! I believe most of you are already on Slack. If not, you can request an invitation here: https://slack-invite.bokeh.org/

And, note that we won't be assigning this issue to anyone, because all applicants can work on these microtasks. :)

@Med16-11
Copy link

Med16-11 commented Mar 18, 2023

Hello @pavithraes ! I am done with both the micro task, now I am starting my work on documentation tag issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
outreachy-may-2023 Internship projects for Outreachy's May 2023 round
Projects
None yet
Development

No branches or pull requests

7 participants