@@ -4,6 +4,7 @@ categories:
44open-source
55collaboration
66community
7+ quantifying-the-commons
78---
89author: Oreoluwa
910---
@@ -20,28 +21,28 @@ key takeaways from the first half of my internship.
2021
2122Quantifying the commons aims to track and analyse the trends of the creative
2223commons legal tools. Who is using these legal tools, where, why, how? We want to
23- measure the impact of these tools. For the past 25 years, the efforts that have
24+ measure the impact of these tools. For the past 25 years, efforts have
2425been made by the organisation to democratize knowledge and content on the
2526internet. We want to identify our growth, gaps and areas for development.
2627
27- ### A brief history I learnt about:
28+ ### A brief history I learnt about
2829
2930After watching a documentary recommended by my mentor. I learnt about a great
3031man called Aaron Schwartz who is also known as internet's own boy. He believed
3132knowledge should be free and accessible to everyone. His ideas helped inspire
3233movements like Creative Commons, which allows creators to share their work
33- legally while choosing how others can use it. I reasonate well with this
34+ legally while choosing how others can use it. I resonate well with this
3435movement because I realised how much knowledge I have gained from reading
35- articles and my random searches on the internet. I feel really exicted to be
36+ articles and my random searches on the internet. I feel really excited to be
3637contributing to this mission.
3738
38- ## Progress so far:
39+ ## Progress so far
3940
40- ### Aligning the project better to the script requirements:
41+ ### Aligning the project better to the script requirements
4142
42- - ** One of the main script requirement is making the script repeatable:** \
43+ - #### One of the main script requirement is making the script repeatable:
4344
44- We use github actions to automate our python script on a quarterly basis. So
45+ We use Github Actions to automate our python script on a quarterly basis. So
4546there is an execution schedule that runs for 45 days or less. For better
4647efficiency, scripts must exit early if a task is already completed and must
4748reliably continue at the appropriate spot if multiple runs are required and not
@@ -51,34 +52,34 @@ or day. So we continue to fetch after the specified hour or day. During my work
5152on the project, I implemented a mechanism that checks for completion of fetch
5253scripts and allows the script to continue from when it stops during any
5354interruption. I integrated a workflow that checks if an output has been
54- generated previously to avoid regeneration or running of script continously ,
55+ generated previously to avoid regeneration or running of script continuously ,
5556when we have an output already.
5657
57- - ** Another script requirement is making the script idempotent:** \
58+ - #### Another script requirement is making the script idempotent:
5859
5960Making the script idempotent means executing the python scripts multiple times
6061and still get the same output. Before my work on the project, the report scripts
61- usually append it sections to the readme using the updatereadme function and
62+ usually append it sections to the readme using the ` update_readme() ` function and
6263this allows the order of outputs to change. For example when I run a script, I
6364can get A-B-C but when I run it again maybe in the next quarter. I could get
6465B-C-A, we don't want it like that. It should be predictable and consistent
6566across quarters. But now,it inserts the sections alphabetically to the right
66- postion regardless of how the python scripts were executed. So we get A-B-C in
67+ position regardless of how the python scripts were executed. So we get A-B-C in
6768quarter 1 and A-B-C in quarter 2.
6869
69- - ** Documentation on the project:** \
70+ - #### Documentation on the project:
7071
7172Improving contributors experience is a big part of the project. During the
72- outreachy contribution phase, new contributors kept on asking the same questions
73+ Outreachy contribution phase, new contributors kept on asking the same questions
7374over and over again because there were some lack of information in the
7475documentation. Timid Robot and I tried to identify areas that were lacking
7576clarity and we put in more context into the sides of the documentation.
7677
7778
78- - ** Completing the three stages of report for existing scripts:** \
79+ - #### Completing the three stages of report for existing scripts:
7980
80- Previous contributions had incompleted stages of report for a particular data
81- source. I worked on completing the process and report stage for the openverse
81+ Previous contributions had incomplete stages of report for a particular data
82+ source. I worked on completing the process and report stage for the Openverse
8283data source. This required understanding the data fetched and what meaningful
8384data or insight can be beneficial for the different teams in the organisation.
8485
@@ -106,4 +107,4 @@ within constraints or limitations that could affect outcomes. Through this, I
106107realized the importance of building the simplest possible architecture first,
107108and then gradually adding components as the solution evolves.
108109
109- I am exicted to embark on the next half! I hope to make more impact on this project.
110+ I am excited to embark on the next half! I hope to make more impact on this project.
0 commit comments