Season of Docs (similar to GSOC but for documentation)

Contributions from the participants, questions and answers to their projects.
Discussions of proposals for upcoming events.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Season of Docs (similar to GSOC but for documentation)

Post by Kunda1 »

https://developers.google.com/season-of-docs/
There is a new program like Google Summer of Code that focuses entirely on creating technical documentation for open source projects: Its called "Season of Docs"
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Season of Docs (similar to GSOC but for documentation)

Post by yorik »

Yes, they announced that at the latest GSOC meeting.
The idea is similar to GSOC, but with these differences:
- Not for students, but for professional tech writers
- Not paid

So I'm really not sure if it will attract many candidates. In any case we could see with our GSOC friend projects if anyone is interested in participating...
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Season of Docs (similar to GSOC but for documentation)

Post by Kunda1 »

yorik wrote: Wed Mar 13, 2019 2:28 pm So I'm really not sure if it will attract many candidates. In any case we could see with our GSOC friend projects if anyone is interested in participating...
We should still push this somehow to get exposure, don't you think?
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Season of Docs (similar to GSOC but for documentation)

Post by yorik »

Hmm the deadline to apply is tomorrow https://developers.google.com/season-of ... s/timeline
I know the folks at openscad applied: https://www.openscad.org/gsod-2019.html But I don't know of any other project that did it...

Honestly I don't really know what we could ask to potential interested people... Write tutorials? Write some guides? But about what specifically? Make the wiki better? But that's a very sensitive topic, and people coming "from outside" to do heavy work on the wiki is likely to cause problems...

Also, personally I don't really want much to spend time on this because I think it will require some, and I'm already not able to dedicate all the time I want on other areas of FreeCAD... But if anyone else would want to give it a try, I think setup a wiki page similar to the openscad one, and fill the form at https://developers.google.com/season-of ... t-started/ until tomorrow is all that's required, and might be doable.

The ball is yours now @Kunda1 :D Interested?
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Season of Docs (similar to GSOC but for documentation)

Post by Kunda1 »

yorik wrote: Mon Apr 22, 2019 2:37 pm The ball is yours now @Kunda1 Interested?
Sorry, I missed the deadline for this. We can better prepare for it next year. :geek:
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Season of Docs (similar to GSOC but for documentation)

Post by yorik »

Yes! Both BRL-CAD and OpenSCAD have applied, let's see how that goes for them, next year we can prepare better!
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: GSOC 2020 (Voice your opinion and ideas about what to propose for the next gsoc)

Post by Kunda1 »

I think though, highest priority should be getting documentation written.
  • Documenting the structure of .FCstd files (fully up to date, incl. App::Link) so other apps can read FC files
  • Document FEM (see where we're at after @m42kus's GSOC gets merged)
  • Document TechDraw
  • Implement a documentation workflow for PRs (especially that change the API)
  • Decide how we will proceed with @m42kus's work with sphinx and doxygen and nail down a workflow
References:
https://www.freecadweb.org/api/namespaces.html
https://www.freecadweb.org/api/classes.html
https://www.freecadweb.org/api/functions.html
https://www.freecadweb.org/api/hierarchy.html
https://www.freecadweb.org/api/modules.html
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Season of Docs (similar to GSOC but for documentation)

Post by Kunda1 »

Let's think about applying for the next 'Season'
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
jnxd
Posts: 951
Joined: Mon Mar 30, 2015 2:30 pm
Contact:

Re: Season of Docs (similar to GSOC but for documentation)

Post by jnxd »

@Kunda1 did the season not arrive? They apparently are accepting org applications currently, until 24th.

https://developers.google.com/season-of ... et-started.

There are multiple wiki pages that could use some changes I guess. I don't know if translations are accepted as well.

@yorik, @kkremitzki I had messaged you separately earlier, but I guess this is also a good place.
My latest (or last) project: B-spline Construction Project.
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Season of Docs (similar to GSOC but for documentation)

Post by yorik »

We could apply, there is still time (deadline for registering orgs is march 24th). However, as I read in https://developers.google.com/season-of ... dmin-guide

- We need people to take charge of this. I can, but I don't have enough time available to do it alone.
- We need a clear list of tasks to be done. That's basically the difficult point here.
- We need mentors.

Anyone willing to work on this?
Post Reply