Hi everyone,
My Week 1 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-1-update-43f...
Week 2 update will be up by Saturday, 11pm, GMT8+.
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Week 2 update is here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-2-update-87f...
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Week 3 update is here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-3-update-de6...
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 4:
For this week, I wrote the 5th section of Instructions for Migration from Mailman 2 to Mailman 3. In this section, I wrote steps that should be taken after post-migration.
Week 4 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-4-update-f92de64ff28c?source=friends_link&sk=cfa42baae967865880b9e8229b5316c3
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 5:
For this week, I wrote a guide called ‘Why Should You Migrate from Mailman 2 to Mailman 3’. It talked about the pros of Mailman 3 as compared to Mailman 2. Just like the week before, everything worked out well.
Week 5 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-5-update-46d...
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 6:
For this week, I started to work on writing the ‘Documentation Guidelines’. I wrote the first 2 sections of the guide: Introduction and How Can You Contribute to Documentation.
Week 6 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-6-update-f3a...
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 7:
For this week, I wrote the remaining sections of Documentation Guidelines:
- When Should You Use “Note/Info/Warning” Boxes
- When Should You Include Videos
- Documentation Styles
- Cheat Sheet for reStructuredText
Week 7 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-7-update-141...
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 8:
For this week, I wrote the first two sections of Documentation Checklist:
- Introduction
- Why Should Users Read the Guide
Since it’s almost review week, I tried to access GitLab to upload my work. Unfortunately, my university blocks GitLab. I’m not sure why but it took me a week to figure that out. I thought the website was down for a week. But when it showed the same error as accessing a gaming website, I knew they blocked it.
My second challenge is probably trying to find a time to write despite having mid term papers, assignments, projects, and establishing a club in campus. It was tough but not impossible.
Week 8 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-8-update-520bb8a50dec?source=friends_link&sk=f7dde5e874914fb486b7147f5d5bd7e9
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 9:
For this week, I wrote the remaining sections of Documentation Checklist, which was later renamed to Documentation Template:
- Post Content
This section describes the reader on what he/she will accomplish after following the documentation.
- Result
This section describes the expected result of following the documentation.
I still couldn’t access GitLab inside my university. And since the whole process of getting it unblocked is quite tedious, I decided to just go to a local Starbucks and use the WiFi there. I created a private repository for my GSOD project and gave access to my mentors, Abhilash and Stephen.
Week 9 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-9-update-5c0ae91a8ee7?source=friends_link&sk=a014bc478570dec29e299919040af957
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for week 10:
For this week, I uploaded my work on GitLab. Since I’ve written my work in the .docx format, I have to restructure them as Mailman documentation uses .rst format. This is the first time that my mentors are seeing my work and I’m still waiting for their feedback on that. But I do hope that they like my straightforward and concise approach when it comes to writing. Either way, I’m open to criticisms.
As for the challenge part, I got my braces this week. So the first three days was filled with pain, slept most of the time. I couldn’t write anything. But after three days, I bounced back and continued writing.
Week 10 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-10-update-b3239cd81586?source=friends_link&sk=e32d3e56b8b9a792235ce8eb0b1df160
Thank you.
Best Regards, Ariessa Norramli
Hi everyone,
Here's an update for Week 11:
For this week, I uploaded the following files on GitLab:
What You Should Know Before Migration This documentation explains what users should know before migrating from Mailman 2 to Mailman 3.
How to Start Contributing in Documentation In this guide, users will learn how to contribute to documentation.
Documentation Template This template provides guidance to users in writing documentation
The challenge for this week is not receiving any feedback or comments from mentors regarding my work. I’ve already emailed them but still waiting for reply. I’m concerned whether my work fulfills the project requirements or not.
Hi everyone,
Here's an update for Week 12:
For this week, I finalized all documentation by proofreading, editing, and adding minor details to ensure that my project meet all requirements. I also added another documentation, which is Quickstart reStructuredText. The documentation serves as a quick syntax guide to reStructuredText.
I still haven’t heard back from any of my mentors for GSOD. Honestly, it’s a challenge because I don’t know whether they approve my way of writing documentation or not. Even so, I sent an email again to request for review.
Update: My mentor has replied my email!
Week 12 update can be viewed here: https://medium.com/@ariessa_norramli/google-season-of-docs-week-12-update-7780f481fadf?source=friends_link&sk=70e0664bef4a0611a7854b8e0570b2f7
Thank you.
Best Regards, Ariessa Norramli
participants (1)
-
ariessa.norramli@gmail.com