Skip to content

Commit 7ad5a68

Browse files
committed
Squashed commit of the following:
commit edfdc4fc666864b9ae11a783d377df9a6346b05d Author: speco29 <sdiya5556@gmail.com> Date: Tue Mar 18 19:42:33 2025 +0530 Improved the proposal, also added new idea for translation. commit 91a30cb1a7c37db1e3d5484f5acdeb4ee5e85c74 Author: speco29 <sdiya5556@gmail.com> Date: Sun Feb 23 15:41:45 2025 +0530 Adding a proposal to accomplish the upcoming plans for DISCOVER-Cookbook
1 parent 6214d36 commit 7ad5a68

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

docs/proposals/001-Translations.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
## Title
2+
Translation Project for DISCOVER-Cookbook
3+
4+
## Abstract
5+
The NumFOCUS DISCOVER-Cookbook (Diverse & Inclusive Spaces and Conferences: Overall Vision and Essential Resources) is a guide for organizing more diverse and inclusive events and conferences. Translating the content will make it accessible to a broader audience, fostering a global community of users. The project involves generating translations for the DISCOVER-cookbook, integrating language selection switches, updating translations as content changes, and engaging translators to contribute.
6+
7+
## Technical Details
8+
9+
### 1. Generating Translations
10+
**What We Are Doing:** Translating the entire content of the DISCOVER-cookbook into multiple languages.
11+
12+
**Technical Approach:**
13+
- Working with translation communities that could provide the translation and feedback, e.g. [translatewiki](https://translatewiki.net/).
14+
15+
- Machine Translation APIs: [Google Cloud Translation API](https://cloud.google.com/translate), [Microsoft Translator Text API](https://azure.microsoft.com/en-us/services/cognitive-services/translator/).
16+
- Establish a workflow for translating existing content, ensuring consistency and accuracy.
17+
18+
**Translation Workflow:**
19+
- Source content is pushed to a repository.
20+
- Automatic translation requests are sent to Machine Translation APIs.
21+
- Translations are reviewed and edited by human translators using a Translation Management System.
22+
- Translations are merged back into the repository.
23+
24+
### 2. Adding Language Switches
25+
**What We Are Doing:** Integrating switches within the book to allow users to select their preferred language.
26+
27+
**Technical Approach:**
28+
- Identify and implement language switch mechanisms (e.g., dropdown menus, toggle buttons) within the book's platform.
29+
- YAML-based translation and Jinja2 templates are flexible for multilingual content.
30+
- Test the functionality across different devices and browsers to ensure seamless language switching.
31+
32+
### 3. Updating Translations
33+
**What We Are Doing:** Developing a system to update translations as the book's content changes.
34+
35+
**Technical Approach:**
36+
- Create a process for tracking changes in the original content.
37+
- Version Control Systems: Git with GitHub Actions, Crowdin.
38+
- Implement a notification system to inform translators of updates.
39+
40+
### 4. Engaging Translators
41+
**What We Are Doing:** Calling for translators to sign up and get tagged for their contributions.
42+
43+
**Technical Approach:**
44+
- Announce a call for translators on relevant platforms (e.g., social media, forums, community websites).
45+
- Web Forms and Authentication: Using [Google Forms](https://www.google.com/forms/about/) or [Typeform](https://www.typeform.com/) for sign-ups, along with authentication tools like [Auth0](https://auth0.com/).
46+
- Develop a tagging system to acknowledge and credit translators for their contributions.
47+
- Provide resources and support for translators to ensure high-quality translations (e.g., guidelines, glossaries, support forums).
48+
49+
## Schedule of Deliverables
50+
**Community Bonding Period**
51+
- Get to know the community better.
52+
- Ensure build environment is set up.
53+
- Discuss project in detail with the community.
54+
55+
**Phase 1**
56+
- Initial translation of existing content.
57+
58+
**Phase 2**
59+
- Integration of language switches.
60+
61+
**Phase 3**
62+
- System for updating translations.
63+
64+
**Phase 4**
65+
- Engagement and onboarding of translators.
66+
67+
**Final Week**
68+
- Finish up the project.
69+
70+
## Development Experience
71+
**Contributions on DISCOVER-Cookbook ([DISCOVER-Cookbook](https://github.com/numfocus/DISCOVER-Cookbook)):**
72+
- Adds Infectious Disease Precautions to health protocols [PR 181](https://github.com/numfocus/DISCOVER-Cookbook/pull/181)
73+
- Adding a QA guide to improve asking questions inclusively [PR 180](https://github.com/numfocus/DISCOVER-Cookbook/pull/180)
74+
- Updated the document to enhance accessibility for attendees with disabilities at conferences. [PR 171](https://github.com/numfocus/DISCOVER-Cookbook/pull/171)
75+
- Added a printable DISCOVER-Cookbook checklist for the organizers [PR 166](https://github.com/numfocus/DISCOVER-Cookbook/pull/166)
76+
77+
**Contributions on other NumFOCUS projects:**
78+
- Updated geovisualization, README.md, installation.rst. Added legendgram to geovisualization, updated README.md with graph module and added installation for graph in --installation.rst [PR 1361](https://github.com/pysal/pysal/pull/1361)
79+
- Added the missing dependency ([https://github.com/pysal/momepy/pull/681](https://github.com/pysal/momepy/pull/681))
80+
- Added ruff and pre-commit in the contributing file ([https://github.com/pysal/momepy/pull/683](https://github.com/pysal/momepy/pull/683))
81+
- Updated the formulations in the docs ([https://github.com/pysal/spopt/pull/468](https://github.com/pysal/spopt/pull/468))
82+
83+
**Contributions to Bambi ([bambi](https://github.com/bambinos/bambi)):**
84+
- Addresses #644 Questions for FAQ [PR 881](https://github.com/bambinos/bambi/pull/881)
85+
- Adding piecewise regression examples in example docs [PR](https://github.com/bambinos/bambi/pull/884)
86+
- Created truncatedprior.py [PR 885](https://github.com/bambinos/bambi/pull/885)
87+
88+
**Contributions to other projects:**
89+
- Added feedback template [PR 1](https://github.com/speco29/advisory-database/pull/1)
90+
- Added contributing.md to the project [PR 7](https://github.com/numfocus/MOSS/pull/7)
91+
- Correcting the title of English lecture, which was written in Spanish [PR 374](https://github.com/PyAr/PyZombis/pull/374)
92+
93+
**Other Experiences**
94+
- Currently working on a hackathon project named PyPiePie [PyPiePie](https://github.com/AstroAirafar/PyPiePie): A game to teach Python via stories and projects.
95+
96+
## Why This Project?
97+
The NumFOCUS DISCOVER Cookbook is a transformative initiative aimed at fostering diversity and inclusion in the scientific and computing communities. It fosters the following:
98+
- Promoting Diversity and Inclusion.
99+
- Empowering Communities.
100+
- Long-Term Change: The project aims to create lasting change by embedding diversity and inclusion into the fabric of scientific conferences and events. This enduring impact benefits current and future generations of scientists and technologists.
101+
102+
## Why Do You Want to Do This Project?
103+
I am deeply committed to promoting diversity and inclusion in all areas of life, including the scientific and computing communities. This project aligns perfectly with my values and aspirations. My background in software development, data analysis, and project planning makes me well-suited to contribute effectively to this project. I can apply my skills to create comprehensive and user-friendly resources. This project provides a unique opportunity to learn from experts in diversity and inclusion, expanding my knowledge and understanding of these crucial areas. Being part of the NumFOCUS DISCOVER Cookbook project means contributing to meaningful change that enhances the inclusivity and accessibility of scientific events. This impact resonates with my desire to make a positive difference in the world.

0 commit comments

Comments
 (0)