Season of Docs (similar to GSOC but for documentation)

Have some feature requests, feedback, cool stuff to share, or want to know where FreeCAD is going? This is the place.
Forum rules
Be nice to others! Read the FreeCAD code of conduct!
User avatar
Kunda1
Posts: 7532
Joined: Thu Jan 05, 2017 9:03 pm

Season of Docs (similar to GSOC but for documentation)

Postby Kunda1 » Tue Mar 12, 2019 5:20 pm

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"
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
yorik
Site Admin
Posts: 11945
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

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

Postby yorik » Wed Mar 13, 2019 2:28 pm

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
Posts: 7532
Joined: Thu Jan 05, 2017 9:03 pm

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

Postby Kunda1 » Fri Apr 19, 2019 1:55 pm

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?
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
yorik
Site Admin
Posts: 11945
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

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

Postby yorik » Mon Apr 22, 2019 2:37 pm

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
Posts: 7532
Joined: Thu Jan 05, 2017 9:03 pm

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

Postby Kunda1 » Thu Apr 25, 2019 11:54 pm

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:
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
yorik
Site Admin
Posts: 11945
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

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

Postby yorik » Mon Apr 29, 2019 1:23 pm

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
Posts: 7532
Joined: Thu Jan 05, 2017 9:03 pm

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

Postby Kunda1 » Sat Sep 28, 2019 12:06 am

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
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 7532
Joined: Thu Jan 05, 2017 9:03 pm

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

Postby Kunda1 » Sat Sep 28, 2019 11:55 am

Let's think about applying for the next 'Season'
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features