Skip to content

Commit 1149d73

Browse files
jaimergpssurbhi560
andcommitted
add blog/2022-08-26-outreachy-wrap-up-blog-2022.md
Co-authored-by: ssurbhi560 <[email protected]>
1 parent 45d20ad commit 1149d73

File tree

1 file changed

+173
-0
lines changed

1 file changed

+173
-0
lines changed
Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
authors:
3+
- name: Surbhi Sharma
4+
title: Outreachy intern
5+
url: https://github.com/ssurbhi560
6+
image_url: https://github.com/ssurbhi560.png
7+
tags: [Outreachy]
8+
---
9+
10+
# Outreachy 2022 Wrap-up Blog
11+
12+
This blog is about my work during my Outreachy internship with
13+
[conda-forge](https://conda-forge.github.io). Before that a little about
14+
me - I am [Surbhi](https://github.com/ssurbhi560), an Outreachy intern
15+
with conda-forge for the May-August 2022 cohort and I worked on
16+
documenting the conda-forge ecosystem.
17+
18+
<!--truncate-->
19+
20+
The first issue I started working on when the internship began was
21+
[Better anchoring of
22+
announcements(#1611)](https://github.com/conda-forge/conda-forge.github.io/issues/1611).
23+
The goal of this issue was to fix the anchor for each year and also
24+
specific announcements in the Announcements section so as to provide
25+
better navigation of the [Announcements
26+
page](https://conda-forge.org/docs/user/announcements.html). This was
27+
also the time when I was feeling quite overwhelmed and anxious since I
28+
was just starting and was unsure if I would be able to give my best. But
29+
thanks to my awesome mentors
30+
[@Katherine](https://github.com/kathatherine) and
31+
[@Matt](https://github.com/beckermr), who have always been so helpful,
32+
I was able to have a good start. We solved this issue in two parts. The
33+
first part was to add anchors to each year which is solved with [Improve
34+
anchors for each year in the Announcements section.
35+
(#1766)](https://github.com/conda-forge/conda-forge.github.io/pull/1766),
36+
and the second part was adding anchors to each announcement and fixing
37+
the RSS feed.
38+
39+
The part of the documentation I focused on after completing the first
40+
issue was [Maintainers'
41+
Documentation](https://conda-forge.org/docs/maintainer/00_intro.html).
42+
Many open issues needed to be taken care of to make the Maintainers'
43+
documentation more useful and accessible for new maintainers. The open
44+
tickets that we have worked on are:
45+
46+
1. [Document extras feedstock-name
47+
(#1769)](https://github.com/conda-forge/conda-forge.github.io/issues/1769)
48+
and [Explain how to become a maintainer
49+
(#1331)](https://github.com/conda-forge/conda-forge.github.io/issues/1331).
50+
Closed with [add extra section-recipe maintainer and feedstock-name
51+
(#1772)](https://github.com/conda-forge/conda-forge.github.io/pull/1772).
52+
53+
> As we started with improving the Maintainer documentation, these
54+
> were the issues we picked first to work on. The first issue was
55+
> documenting how maintainers can use the "feedstock-name" directive
56+
> for naming feedstocks differently than their package names in
57+
> staged recipes. The second issue was documenting how one should
58+
> become a package maintainer.
59+
60+
2. [Add more steps in Improve the documentation section
61+
(#1651)](https://github.com/conda-forge/conda-forge.github.io/issues/1651).
62+
Closed with [Update "Improve the documentation" section with more
63+
steps
64+
(#1776)](https://github.com/conda-forge/conda-forge.github.io/pull/1776).
65+
66+
> In this issue we added some additional steps for people who would
67+
> like to start contributing to conda-forge, especially to
68+
> documentation.
69+
70+
3. [Add more information about Grayskull in the documentation itself
71+
(#1655)](https://github.com/conda-forge/conda-forge.github.io/issues/1655).
72+
Closed with
73+
[#1777](https://github.com/conda-forge/conda-forge.github.io/pull/1777).
74+
75+
> The documentation on Grayskull in docs lacked the answers to
76+
> questions like what exactly Grayskull is and how one should use
77+
> Grayskull to generate a recipe. With this issue, we added more
78+
> documentation on Grayskull for users.
79+
80+
4. [Clarify feedstock LICENSE.txt
81+
(#803)](https://github.com/conda-forge/conda-forge.github.io/issues/803).
82+
Closed with [Add Feedstock repository structure section
83+
(#1786)](https://github.com/conda-forge/conda-forge.github.io/pull/1786).
84+
85+
> The docs for contributing and maintaining conda recipes discuss
86+
> when and how to distribute the license for a particular package.
87+
> The auto-generated feedstock repositories also include a license
88+
> in the root, which is different from the related package license.
89+
> With this issue, we added documentation on the differences between
90+
> those two licenses and briefly explained the feedstock repository
91+
> structure.
92+
93+
5. [DOC: New maintainer
94+
(#1117)](https://github.com/conda-forge/conda-forge.github.io/issues/1117).
95+
Closed with [Add "How regro-cf-autotick-bot create version update
96+
PR?" section.
97+
(#1788)](https://github.com/conda-forge/conda-forge.github.io/pull/1788).
98+
99+
> With this issue we improved docs for the new maintainers and the
100+
> working of the bot. A "How does `regro-cf-autotick-bot` create
101+
> automatic version updates?" section was added to the docs, which
102+
> explains the whole process of creating an automated version update
103+
> PRs by bot.
104+
105+
6. [Add Perl package hints to documentation
106+
(#1536)](https://github.com/conda-forge/conda-forge.github.io/issues/1536).
107+
Working on this
108+
[#1790](https://github.com/conda-forge/conda-forge.github.io/pull/1790).
109+
110+
> With this issue we added ​​packaging instructions for Perl packages
111+
> with different build systems in the documentation.
112+
113+
7. [DOC: Update documentation about tokens
114+
(#1532)](https://github.com/conda-forge/conda-forge.github.io/issues/1532).
115+
Closed with
116+
[#1793](https://github.com/conda-forge/conda-forge.github.io/pull/1793).
117+
118+
> Feedstocks have stopped storing encrypted tokens to upload
119+
> packages, but outdated information on tokens was still present in
120+
> the documentation. With this issue we removed the outdated
121+
> information and also added a new section "How to update your
122+
> feedstock token?" for maintainers.
123+
124+
8. [Improve the documentation on arch_rebuild.txt
125+
(#1668)](https://github.com/conda-forge/conda-forge.github.io/issues/1668).
126+
Closed with
127+
[#1794](https://github.com/conda-forge/conda-forge.github.io/pull/1794).
128+
129+
> With this issue we improved the documentation on
130+
> `arch_rebuild.txt` and how maintainers can add a feedstock to
131+
> `arch-rebuild.txt` if it requires rebuilding with different
132+
> architectures/platforms (such as ppc64le or aarch64).
133+
134+
9. [Document migrators
135+
(#1355)](https://github.com/conda-forge/conda-forge.github.io/issues/1355),
136+
[Update migration docs
137+
(#862)](https://github.com/conda-forge/conda-forge.github.io/issues/862),
138+
and [document migrators
139+
(#737)](https://github.com/conda-forge/conda-forge.github.io/issues/737)
140+
. Closed with [Documenting Migrators and Migrations.
141+
(#1801)](https://github.com/conda-forge/conda-forge.github.io/pull/1801).
142+
143+
> With these, we added more documentation on migrations and
144+
> migrators, which would help maintainers find answers to questions
145+
> like - What is a migrator/migration, and what does it do? When can
146+
> (and why would) they should reject a migration PR? And so on.
147+
148+
10. [Add a section in docs on security aspects of conda-forge
149+
(#1808)](https://github.com/conda-forge/conda-forge.github.io/issues/1808).
150+
Closed with
151+
[#1812](https://github.com/conda-forge/conda-forge.github.io/pull/1812).
152+
153+
> Currently, information regarding the security considerations of
154+
> conda-forge builds is scattered throughout the documentation, and
155+
> therefore it is hard to find and read. With this issue, we will
156+
> put all the information together in one place, which will help
157+
> maintainers and users to know more about how conda-forge secures
158+
> its packages and infrastructure.
159+
160+
I met some wonderful people during the internship who helped me with all
161+
my questions and doubts that I had. The experience during the internship
162+
also helped me get better opportunities after completing the Outreachy
163+
internship. I have learned so many things during the internship that it
164+
would make a long list if I were to write all of those. But the most
165+
important things I learned are:
166+
167+
- The importance of documentation and how to write good documentation.
168+
- The best practices to follow while writing documentation.
169+
- More about conda-forge and packaging tools.
170+
171+
And above all, Outreachy helped me feel more confident about my skills
172+
and overcome the imposter syndrome I had before. Thanks again to my
173+
awesome mentors and the kind people of the conda-forge community! :)

0 commit comments

Comments
 (0)