-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathgsod.html
808 lines (626 loc) · 37.5 KB
/
gsod.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Google Season of Docs: Case Study — Geomstats latest documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=c6e86fd7"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'gsod';</script>
<link rel="canonical" href="geomstats.github.io/gsod.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Hackathons" href="hackathons.html" />
<link rel="prev" title="Geomstats governance and decision-making" href="governance.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="latest" />
<meta name="docbuild:last-update" content="Feb 28, 2025, 7:02:04 PM"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<p class="title logo__title">Geomstats latest documentation</p>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="explanation/index.html">
Explanation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorials/index.html">
Tutorials
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="contributing/index.html">
Contributing Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/index.html">
API Reference
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="roadmap.html">
Roadmap
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="governance.html">
Governance
</a>
</li>
<li class=" current active">
<a class="nav-link dropdown-item nav-internal" href="#">
Google Season of Docs
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="hackathons.html">
Hackathons
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="explanation/index.html">
Explanation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorials/index.html">
Tutorials
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="contributing/index.html">
Contributing Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/index.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="roadmap.html">
Roadmap
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="governance.html">
Governance
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Google Season of Docs
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="hackathons.html">
Hackathons
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Google Season of Docs: Case Study</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="google-season-of-docs-case-study">
<span id="gsod"></span><h1>Google Season of Docs: Case Study<a class="headerlink" href="#google-season-of-docs-case-study" title="Link to this heading">#</a></h1>
<p>The original proposal submitted to Google Season of Docs page is at the botton of this page.</p>
<section id="design-and-organize-scattered-documentation-in-geomstats">
<h2>Design and Organize Scattered Documentation in Geomstats<a class="headerlink" href="#design-and-organize-scattered-documentation-in-geomstats" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Organization:</p></li>
</ul>
<p>Geomstats.</p>
<ul class="simple">
<li><p>Organization Description:</p></li>
</ul>
<p>Geomstats is an open-source Python package for computations and statistics on nonlinear manifolds, such as hyperspheres, hyperbolic spaces, Lie groups of transformations, among others. As such, the package supports research within the fast growing field of Geometric (Deep) Learning.</p>
<p>The <a class="reference external" href="https://github.com/geomstats/geomstats">source code</a> is freely available on GitHub. Geomstats is organized into two main modules:
<cite>geometry</cite> and <cite>learning</cite>. The module <cite>geometry</cite> implements concepts in differential geometry. The module <cite>learning</cite> implements statistics and learning algorithms for data on manifolds. The code is object-oriented and classes inherit from scikit-learn’s base classes and mixins.</p>
<p>Geomstats has found numerous applications, for example in the biomedical fields for machine learning applied to biological shape analysis. Typical usecases can be found within the <a class="reference external" href="https://github.com/geomstats/geomstats/blob/main/notebooks/">notebooks folder</a>.</p>
</section>
<section id="problem-statement">
<h2>Problem Statement<a class="headerlink" href="#problem-statement" title="Link to this heading">#</a></h2>
<p>Current Geomstats documentation had two main problems:
- the documentation website lacks a professional design,
- the documentation is scattered across docstrings, example python scripts, how-to jupyter notebooks, tutorials, arxiv review papers.</p>
<p>As a result, potential new contributors often failed to understand the implementation of the library and renounced in participating to its development.</p>
<p>The goal of this project was to adopt the documentation system of divio, to design and reorganize our scattered documentation.</p>
</section>
<section id="proposal-abstract">
<h2>Proposal Abstract<a class="headerlink" href="#proposal-abstract" title="Link to this heading">#</a></h2>
<p>Our original organization proposal stated the following goals towards solving the problem stated above:</p>
<ul class="simple">
<li><p>Propose and implement a new design for Geomstats documentation website.</p></li>
<li><p>Audit existing Geomstats documentation across Python scripts, jupyter notebooks, docstrings and pdf documents.</p></li>
<li><p>Organize existing documentation within the website, using divio documentation principles.</p></li>
<li><p>Update README.rst and CONTRIBUTING.rst with the aim to better onboard new contributors; Add a checklist for new contributors’ first Pull Requests.</p></li>
<li><p>Add missing references and mathematical formulas to docstrings.</p></li>
<li><p>Incorporate feedback from documentation testers and Geomstats community.</p></li>
</ul>
<p>The original proposal page can be found at the bottom of this webpage.</p>
</section>
<section id="project-description">
<h2>Project Description<a class="headerlink" href="#project-description" title="Link to this heading">#</a></h2>
<p>There were no obstacles to coming up with our Season of Docs proposal. We were discussing our lack of resources in order to improve our documentation for a long time. We were aware of its issues by our frequent discussions with contributors and users. The proposal organically emerged by summarizing all feedback and comments made during these discussions.</p>
</section>
<section id="budget">
<h2>Budget<a class="headerlink" href="#budget" title="Link to this heading">#</a></h2>
<p>The proposed budget is included in the original proposal which is found at the botton of this page.</p>
<p>We found it hard to estimate the amount of work required for each of the tasks, as this is dependent on the qualifications of the candidate. We decided to give general objectives to achieve, as opposed to explicit number of lines or web pages to write.</p>
<p>They were no unexpected expenses. Our estimates were correct. We have other resources on Geomstats that we were able to use, e.g. the salaries of engineers working on the repository.</p>
</section>
<section id="participants">
<h2>Participants<a class="headerlink" href="#participants" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>@nanjekyejoannah (technical writer)</p></li>
<li><p>@lpereira95</p></li>
<li><p>@ninamiolane</p></li>
<li><p>@Jules-Deschamps</p></li>
<li><p>@adelemyers99</p></li>
<li><p>@SaitejaUtpala</p></li>
<li><p>@chicken-biryani</p></li>
</ul>
<p>We found the technical writer through advertizing online about the position. We found volunteers among the current open-source maintainers and contributors. They were part of a slack channel where the technical writer could ask questions, and they were asked to perform code reviews on PRs.</p>
</section>
<section id="timeline-and-results">
<h2>Timeline and Results<a class="headerlink" href="#timeline-and-results" title="Link to this heading">#</a></h2>
<p>The milestones in this document are adopted from the planned project scope documented in the Geomstats GSoD page. The technical writer worked an average of 10 hours every week and attempted most of the planned activities unless was ill or was waiting on some feedback.</p>
<p>In collaboration with the project mentors some scopes were adjusted, for example the documentation had been minimally formatted to Divio, a full revamp wasn’t necessary but work went in to improve areas where the Divio principles had not been followed to completion.</p>
<p>Other tasks that may have required much code modification like docstrings had to be paused and PRs closed, in the future someone else can pick up that work. There is still an open PR of a Divio-related refactor that is pending merge if there are no more reviews.</p>
<div class="pst-scrollable-table-container"><table class="table" id="id4">
<caption><span class="caption-text">Title</span><a class="headerlink" href="#id4" title="Link to this table">#</a></caption>
<colgroup>
<col style="width: 50.0%" />
<col style="width: 25.0%" />
<col style="width: 25.0%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>Milestone</p></td>
<td><p>Date</p></td>
<td><p>Result</p></td>
</tr>
<tr class="row-even"><td><p>Audit existing Geomstats documentation across Python scripts, jupyter notebooks, docstrings and pdf documents.</p></td>
<td><p>June 6, 2022</p></td>
<td><p><a class="reference external" href="https://github.com/nanjekyejoannah/geomstats/wiki/Reorganizing-the-contribution-guide">Documentation Audit</a>.</p></td>
</tr>
<tr class="row-odd"><td><p>Propose and implement a new design for Geomstats documentation website.</p></td>
<td><p>June 12, 2022</p></td>
<td><p><a class="reference external" href="https://github.com/geomstats/geomstats/issues/1574">Discussion</a>, <a class="reference external" href="https://github.com/geomstats/geomstats/pulls?q=is%3Apr+author%3Ananjekyejoannah+is%3Aclosed">Template for issue tracker</a></p></td>
</tr>
<tr class="row-even"><td><p>Update README and CONTRIBUTING to better onboard new contributors; Add a checklist for new contributors’ first Pull Requests.</p></td>
<td><p>August 1, 2022</p></td>
<td><p><a class="reference external" href="https://github.com/geomstats/geomstats/pull/1597">Contributor guide</a>.</p></td>
</tr>
<tr class="row-odd"><td><p>Add missing references and mathematical formulas to docstrings.</p></td>
<td><p>October 5, 2022</p></td>
<td><p><a class="reference external" href="https://github.com/geomstats/geomstats/pull/1639">API refactor</a>. <a class="reference external" href="https://github.com/geomstats/geomstats/pull/1663">Split spaces and metrics</a>.</p></td>
</tr>
<tr class="row-even"><td><p>Organize existing documentation within the website, using divio documentation principles.</p></td>
<td><p>November 28, 2022</p></td>
<td><p><a class="reference external" href="https://github.com/geomstats/geomstats/pull/1597">Contributor guide</a>.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="metrics">
<h2>Metrics<a class="headerlink" href="#metrics" title="Link to this heading">#</a></h2>
<p>The metrics we chose to summarize the success of the project are recalled below:
- (a) monthly: number of pull requests from new contributors,
- (b) monthly: percentage of pull requests from new contributors that are merged (within two weeks),
- (c) monthly: number of contributors with >2 pull requests.
- (d) standard metrics (number of views, downloads, web traffic to documentation website, time on page), monthly after the documentation is published.</p>
<p>We will consider the project successful if, after publication of the new documentation at least three of the following hold:</p>
<ul class="simple">
<li><p>The number of pull requests by new contributors increases by 15%.</p></li>
<li><p>The percentage of pull requests by new contributors that are merged within two weeks increases by 15%.</p></li>
<li><p>The number of new contributors with >2 merged pull requests increases by 10% (beginning the quarter after the documentation is published).</p></li>
<li><p>The standard metrics increase by 10% on average.</p></li>
<li><p>The number of GitHub forks and stars increases by 10%.</p></li>
</ul>
<p>Now that the documentation has been updated, we will track these metrics over the next 6 months to determine whether contributors feel an improvement.</p>
</section>
<section id="analysis">
<h2>Analysis<a class="headerlink" href="#analysis" title="Link to this heading">#</a></h2>
<p>We believe that this project was successful because the documentation seems more accessible. However, we will need to evaluate our metrics (given in the original proposal, see below) over the course of the next year and see the informal feedback gathered through our discussions with contributors and users.</p>
</section>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Link to this heading">#</a></h2>
<p>The Google Season of Docs was a great experience. It was very interesting to have a technical writer originally external to the project delve into the documentation. It highlights specifically well the problems that can exist within our current documentation website.</p>
<p>In the future, we would probably think more ahead in terms of the time zones of the different participants. As our participants were spanning several continents, it was sometimes complicated to have continued discussions.</p>
<p><em>The above case study was conducted based on the project originally proposed, which is given below.</em></p>
</section>
</section>
<section id="google-season-of-docs-project-page">
<h1>Google Season of Docs: Project Page<a class="headerlink" href="#google-season-of-docs-project-page" title="Link to this heading">#</a></h1>
<p>Design and Organize Scattered Documentation - Geomstats</p>
<section id="about-the-organization">
<h2>About the organization<a class="headerlink" href="#about-the-organization" title="Link to this heading">#</a></h2>
<p>Geomstats is an open-source Python package for computations and statistics on nonlinear manifolds, such as hyperspheres, hyperbolic spaces, Lie groups of transformations, among others. As such, the package supports research within the fast growing field of Geometric (Deep) Learning.</p>
<p>In this context, Geomstats provides code to fulfill four objectives:</p>
<ul class="simple">
<li><p>provide educational support to learn “hands-on” differential geometry and geometric statistics and learning, through its examples and visualizations.</p></li>
<li><p>foster research in differential geometry and geometric statistics by providing operations on manifolds to gain intuition on results of a research paper;</p></li>
<li><p>democratize the use of geometric statistics by implementing user-friendly geometric learning algorithms using Scikit-Learn API; and</p></li>
<li><p>provide a platform to share learning algorithms on manifolds.</p></li>
</ul>
<p>The <a class="reference external" href="https://github.com/geomstats/geomstats">source code</a> is freely available on GitHub. Geomstats is organized into two main modules:
<cite>geometry</cite> and <cite>learning</cite>. The module <cite>geometry</cite> implements concepts in differential geometry. The module <cite>learning</cite> implements statistics and learning algorithms for data on manifolds. The code is object-oriented and classes inherit from scikit-learn’s base classes and mixins.</p>
<p>Geomstats has already found numerous applications, for example in the biomedical fields for machine learning applied to biological shape analysis. Typical usecases can be found within the <a class="reference external" href="https://github.com/geomstats/geomstats/blob/main/notebooks/">notebooks folder</a>.</p>
</section>
<section id="about-the-project">
<h2>About the project<a class="headerlink" href="#about-the-project" title="Link to this heading">#</a></h2>
<section id="the-problem">
<h3>The problem<a class="headerlink" href="#the-problem" title="Link to this heading">#</a></h3>
<p>Current Geomstats documentation has two main problems:
- the documentation website lacks a professional design,
- the documentation is scattered across docstrings, example python scripts, how-to jupyter notebooks, tutorials, arxiv review papers.</p>
<p>As a result, potential new contributors often fail to understand the implementation of the library and renounce in participating to its development.</p>
<p>We aim to adopt the documentation system of divio.</p>
</section>
<section id="the-projects-scope">
<h3>The project’s scope<a class="headerlink" href="#the-projects-scope" title="Link to this heading">#</a></h3>
<p>The Geomstats project will:</p>
<ul class="simple">
<li><p>Propose and implement a new design for Geomstats documentation website.</p></li>
<li><p>Audit existing Geomstats documentation across Python scripts, jupyter notebooks, docstrings and pdf documents.</p></li>
<li><p>Organize existing documentation within the website, using divio documentation principles.</p></li>
<li><p>Update README.rst and CONTRIBUTING.rst with the aim to better onboard new contributors; Add a checklist for new contributors’ first Pull Requests.</p></li>
<li><p>Add missing references and mathematical formulas to docstrings.</p></li>
<li><p>Incorporate feedback from documentation testers and Geomstats community.</p></li>
</ul>
<p>Work that is out-of-scope for this project:
- This project will not create any explanation, tutorials or how-to guides.</p>
<p>We estimate that this work will take 6 months to complete. We are in contact with interested technical writers, some having already merged documentation pull requests to the repository.</p>
</section>
<section id="measuring-projects-success">
<h3>Measuring project’s success<a class="headerlink" href="#measuring-projects-success" title="Link to this heading">#</a></h3>
<p>Geomstats receives an average of 50 pull requests a quarter to add a new feature, propose a bug fix or work on the software coding infrastructure. A third of these pull requests are from new contributors. However:
- new contributors’ pull requests are rarely merged, as they do not obide Geomstats coding guidelines, and stall as a result,
- even if the pull request is merged, the new contributor will not submit another one.
We believe that the improved documentation will result in more pull requests from new contributors that will be merged, i.e. less stalled pull requests, and that the enhanced contribution experience will motivate new contributors to submit a second pull request.</p>
<p>We will track the following metrics:
- (a) monthly: number of pull requests from new contributors,
- (b) monthly: percentage of pull requests from new contributors that are merged (within two weeks),
- (c) monthly: number of contributors with >2 pull requests.
- (d) standard metrics (number of views, downloads, web traffic to documentation website, time on page), monthly after the documentation is published.</p>
<p>We would consider the project successful if, after publication of the new documentation at least three of the following hold:</p>
<ul class="simple">
<li><p>The number of pull requests by new contributors increases by 15%.</p></li>
<li><p>The percentage of pull requests by new contributors that are merged within two weeks increases by 15%.</p></li>
<li><p>The number of new contributors with >2 merged pull requests increases by 10% (beginning the quarter after the documentation is published).</p></li>
<li><p>The standard metrics increase by 10% on average.</p></li>
<li><p>The number of GitHub forks and stars increases by 10%.</p></li>
</ul>
</section>
</section>
<section id="proposed-budget">
<h2>Proposed Budget<a class="headerlink" href="#proposed-budget" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="table">
<thead>
<tr class="row-odd"><th class="head"><p><strong>Budget Item</strong></p></th>
<th class="head"><p><strong>Amount</strong></p></th>
<th class="head"><p><strong>Running Total</strong></p></th>
<th class="head"><p><strong>Notes</strong></p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Technical writer</p></td>
<td><p>10,000.00</p></td>
<td><p>10,000.00</p></td>
<td><p>One technical writer for 6 months.</p></td>
</tr>
<tr class="row-odd"><td><p>Volunteer stipends</p></td>
<td><p>500.00</p></td>
<td><p>13,000.00</p></td>
<td><p>Six volunteers stipends.</p></td>
</tr>
<tr class="row-even"><td><p>Project T-shirts and stickers</p></td>
<td><p>150.00</p></td>
<td><p>14,500.00</p></td>
<td><p>Ten project T-shirts, ten stickers.</p></td>
</tr>
<tr class="row-odd"><td><p><strong>Total</strong></p></td>
<td></td>
<td><p><strong>14,500.00</strong></p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="additional-information">
<h2>Additional information<a class="headerlink" href="#additional-information" title="Link to this heading">#</a></h2>
<p>Nina Miolane, principal administrator, has been working with a main student to create the original Geomstats documentation website. She has worked with two engineers to update the documentation website in 2021.</p>
<p>Nina Miolane has been a mentor for <a class="reference external" href="https://www.outreachy.org/">Outreachy</a> and is a mentor + member of the steering committee of the MIT’s <a class="reference external" href="https://sgi.mit.edu/">Summer Geometry Initiative</a>, two programs that are similar to Google Summer of Code and Google Season of Docs. Nina Miolane has co-organized <a class="reference external" href="https://github.com/geomstats/geomstats#contributing">hackathons</a> , <a class="reference external" href="https://github.com/geomstats/challenge-iclr-2021">coding challenges</a>, and <a class="reference external" href="https://www.ninamiolane.com/pagecv">international workshops</a>.</p>
</section>
<section id="important-links-for-technical-writers">
<h2>Important links for technical writers<a class="headerlink" href="#important-links-for-technical-writers" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Find details about being a Google SoD’s writer <a class="reference external" href="https://developers.google.com/season-of-docs/docs/tech-writer-guide">here</a>.</p></li>
<li><p>Feel free to register your interest on the <a class="reference external" href="https://github.com/google/season-of-docs/tree/main/2022-participants">SoD 2022 github repository</a>.</p></li>
<li><p>Submit your statement of interest via email to <a class="reference external" href="mailto:nmiolane%40gmail.com">nmiolane<span>@</span>gmail<span>.</span>com</a> before May 1st, at 18:00 UTC.</p></li>
<li><p>Questions? Join our community through its <a class="reference external" href="https://join.slack.com/t/geomstats/shared_invite/zt-15t8k0q7r-Duxt6j6aA3rDOIms2Vd~RQ">slack workspace</a>!</p></li>
</ul>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="governance.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Geomstats governance and decision-making</p>
</div>
</a>
<a class="right-next"
href="hackathons.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Hackathons</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Google Season of Docs: Case Study</a><ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#design-and-organize-scattered-documentation-in-geomstats">Design and Organize Scattered Documentation in Geomstats</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#problem-statement">Problem Statement</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#proposal-abstract">Proposal Abstract</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#project-description">Project Description</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#budget">Budget</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#participants">Participants</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#timeline-and-results">Timeline and Results</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#metrics">Metrics</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#analysis">Analysis</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary">Summary</a></li>
</ul>
</li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#google-season-of-docs-project-page">Google Season of Docs: Project Page</a><ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#about-the-organization">About the organization</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#about-the-project">About the project</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-problem">The problem</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-projects-scope">The project’s scope</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#measuring-projects-success">Measuring project’s success</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#proposed-budget">Proposed Budget</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-information">Additional information</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#important-links-for-technical-writers">Important links for technical writers</a></li>
</ul>
</li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/gsod.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2022-2023, Geomstats, Inc..
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.1.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>