[Battlemesh] Fwd: Google Season of Docs projects for OpenWrt
baptiste at bitsofnetworks.org
Tue Jun 9 15:33:53 CEST 2020
On 09-06-20, fboehm at aon.at wrote:
> I have some experience in writing technical documentations but more
> importantly just recently stumbled into the minefield of understanding all
> OpenWRT core components. I'm still no expert but I could explain it to a
> newcomer pretty well.
> Unfortunately I couldn't find meaningful information about how much creative
> freedom is allowed in this Google sponsored documentation project. I'm
> asking because I would only want to write it from the perspective of a
> C-Coder with some Linux skills but with zero OpenWRT experience. But if the
> style of this documentation is going to be another Wiki-like collaboration -
> instead of a proofread book - then I'm likely not the right person.
In short, it's pretty free: we are proposing projects, but you can propose
something different. However, it's better to discuss it beforehand (on
the openwrt-devel mailing list) to make sure it really fits a need. We
may not be able to accept all applications so we are more likely to accept
project proposals that were discussed before.
Project 1 is focused on the documentation tooling because we thought it
would be too hard for a non-openwrt-developer to also write low-level
documentation. But if you think you can do both, that's great!
Regarding the format, I don't know what you mean by "proofread book" but
https://openwrt.org/google-season-of-docs makes it clear that we want to
move away from the wiki and use a uniform documentation system for all
OpenWrt core components (probably mkdocs).
> Am 08.06.20 um 14:59 schrieb Baptiste Jonglez:
> > Hi,
> > If you have already been annoyed by the poor documentaton of OpenWrt,
> > there is an opportunity to improve it and get paid doing this.
> > More information below (and before somebody explains, I know, Google is evil).
> > Baptiste
> > ----- Forwarded message from Baptiste Jonglez <baptiste at bitsofnetworks.org> -----
> > Date: Mon, 8 Jun 2020 12:14:08 +0200
> > From: Baptiste Jonglez <baptiste at bitsofnetworks.org>
> > To: openwrt-devel at lists.openwrt.org
> > Subject: Google Season of Docs projects for OpenWrt
> > Hi,
> > As discussed previously, OpenWrt has applied and been accepted for the
> > Season of Docs. We have three mentors (me, Jow, Thomas Hühn), while Hauke
> > and Paul are "project administrators".
> > We started proposing projects here: https://openwrt.org/google-season-of-docs
> > Feel free to discuss the proposed projects here, especially if you plan to
> > apply as a technical writer. The goal is to clarify the projects if
> > needed, and make sure that we provide a good match between projects and
> > technical writer applications.
> > The deadline for applying as a technical writer is July 9, see
> > https://developers.google.com/season-of-docs/docs/timeline
> > More information about being a technical writer (requirements, stipend
> > amount, etc) is here: https://developers.google.com/season-of-docs/docs/tech-writer-guide
> > Baptiste
> > ----- End forwarded message -----
> > _______________________________________________
> > Battlemesh mailing list
> > Battlemesh at ml.ninux.org
> > https://ml.ninux.org/mailman/listinfo/battlemesh
> Battlemesh mailing list
> Battlemesh at ml.ninux.org
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 833 bytes
Desc: not available
More information about the Battlemesh