unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Google Season of Docs 2024
@ 2024-02-12 17:42 Simon Tournier
  2024-02-12 19:39 ` Attila Lendvai
  0 siblings, 1 reply; 4+ messages in thread
From: Simon Tournier @ 2024-02-12 17:42 UTC (permalink / raw)
  To: Guix Devel

Hi,

( It is when my plate is full that I add more in. :-) )

Google is announcing the Season of Docs.  Somehow, it is similar of
Google Summer of Code but for… wait for it… documentation!

https://opensource.googleblog.com/2024/02/announcing-google-season-of-docs-2024.html

I would like that the Guix project applies as an Organization.  Hence my
message.  Before jumping in the boring paperwork, the first questions
are:

 1. Who does volunteer for being potential mentor?
 2. Would one of you readers be interested by being technical writer?
 3. Any for improving the documentation?

Well, shoot any ideas for #3.  It will help in all cases. :-)

It can range from a one line idea to more elaborated idea; as shown here
[1, 2, 3].

Depending on the feedback, I will create a LibrePlanet webpage or else
and go further in the process. :-)

Last, keep in mind the deadline is less than 10 days from now.

1: https://developers.google.com/season-of-docs/docs/project-ideas
2: https://developers.google.com/season-of-docs/docs/case-study-example
3: https://developers.google.com/season-of-docs/docs/2022/participants

Cheers,
simon


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Google Season of Docs 2024
  2024-02-12 17:42 Google Season of Docs 2024 Simon Tournier
@ 2024-02-12 19:39 ` Attila Lendvai
  2024-02-12 23:06   ` Rostislav Svoboda
  0 siblings, 1 reply; 4+ messages in thread
From: Attila Lendvai @ 2024-02-12 19:39 UTC (permalink / raw)
  To: Simon Tournier; +Cc: Guix Devel

> 3. Any for improving the documentation?

just a general wish: much less prose and much more structure, please.

-- 
• attila lendvai
• PGP: 963F 5D5F 45C7 DFCD 0A39
--
“There is no coming to consciousness without pain. People will do anything, no matter how absurd, in order to avoid facing their own Soul. One does not become enlightened by imagining figures of light, but by making the darkness conscious. The latter procedure, however, is disagreeable and therefore not popular.”
	— Carl Jung (1875–1961), 'Alchemical Studies' (1967)



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Google Season of Docs 2024
  2024-02-12 19:39 ` Attila Lendvai
@ 2024-02-12 23:06   ` Rostislav Svoboda
  0 siblings, 0 replies; 4+ messages in thread
From: Rostislav Svoboda @ 2024-02-12 23:06 UTC (permalink / raw)
  To: Attila Lendvai; +Cc: Simon Tournier, Guix Devel

> 3. Any for improving the documentation?

Example snippets for every function. Basically like
https://clojuredocs.org/ but for Guile / Guix.

Thanks in advance.


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Google Season of Docs 2024
@ 2024-02-13 15:10 Juliana Sims
  0 siblings, 0 replies; 4+ messages in thread
From: Juliana Sims @ 2024-02-13 15:10 UTC (permalink / raw)
  To: zimon.toutoune; +Cc: guix-devel

Hi Simon,

I would absolutely be interested in actually writing documentation. I 
appear to be rapidly specializing as a technical writer and have long 
wanted to help write better documentation for Guix (and Guile, for that 
matter...). Reimbursement would allow me to set aside the time 
necessary to actually do it.

With the caveat that I may be doing other things at the same time 
(other grants or contracts or who knows; life is unpredictable), I 
would absolutely be interested in doing some actual writing. I don't 
have hard ideas about how to improve the docs so would be tapping folks 
for and accepting feedback.

- Juli (she/her)




^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2024-02-13 15:11 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-12 17:42 Google Season of Docs 2024 Simon Tournier
2024-02-12 19:39 ` Attila Lendvai
2024-02-12 23:06   ` Rostislav Svoboda
  -- strict thread matches above, loose matches on Subject: below --
2024-02-13 15:10 Juliana Sims

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).