[Plone-docs] documentation sprints 2014

Discussion:

sven

2013-10-15 15:12:37 UTC

Hi,

sorry for x-posting !

The Documentation Team is planning two sprints for 2014 to get the docs
ready for Plone 5 !
To make this happened we need *YOU* !

Roadmap:

Strategic Sprint - around January in Amsterdam, this sprint will focus on:
- Organize documentation
- Setting up docs.plone.org, including /user/en and /user/it
- Prepare the sprint in Munich

Big Documentation Sprint 2014: Munich - around March, this sprint will
focus on:
- Taking down kb and faq and migrating all articles
either to user manual or developer manual
- Fix sphinx build errors
- Solve github tickets

This is a lot of work, the goal is to have the docs ready and running
for Plone 5.
You don't need to be a pro-writer or a core-dev to be able to help,
every help is needed and welcome, we need people to help fixing typos,
sphinx errors and so on and so on.

This is just an early announcement to give you a heads up, more info
about the dates and registration will follow soon.

Sven

Dylan Jay

2013-10-16 14:18:37 UTC

Permalink

Hi,

I won't be able to make this sprints unfortunately however I don't see moving the docs back to plone.org/docs and integrating plone.org search with the docs search. These items, however they are achieved would make for a really nice documentation experience due to how most people search for documentation. If someone wants to take these on I think it would be very much appreciated. I know Mikko already has some ideas on how to integrate search while still hosting via sphinx. I also have some ideas of automated uploading of sphix docs directly into Plone.

Post by sven
Hi,
sorry for x-posting !
The Documentation Team is planning two sprints for 2014 to get the docs
ready for Plone 5 !
To make this happened we need *YOU* !
- Organize documentation
- Setting up docs.plone.org, including /user/en and /user/it
- Prepare the sprint in Munich
Big Documentation Sprint 2014: Munich - around March, this sprint will
- Taking down kb and faq and migrating all articles
either to user manual or developer manual
- Fix sphinx build errors
- Solve github tickets
This is a lot of work, the goal is to have the docs ready and running
for Plone 5.
You don't need to be a pro-writer or a core-dev to be able to help,
every help is needed and welcome, we need people to help fixing typos,
sphinx errors and so on and so on.
This is just an early announcement to give you a heads up, more info
about the dates and registration will follow soon.
Sven
------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60135031&iu=/4140/ostg.clktrk
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

sven

2013-10-24 21:14:43 UTC

Permalink

Hi,

good point, you are right ! We skipped that for the first planning
because there was no one willing to work on that, so we decided for the
moment to 'diazo' it into plone.org, but of course a working search from
plone.org would be really nice !

cheers

Sven

Post by Dylan Jay
Hi,
I won't be able to make this sprints unfortunately however I don't see moving the docs back to plone.org/docs and integrating plone.org search with the docs search. These items, however they are achieved would make for a really nice documentation experience due to how most people search for documentation. If someone wants to take these on I think it would be very much appreciated. I know Mikko already has some ideas on how to integrate search while still hosting via sphinx. I also have some ideas of automated uploading of sphix docs directly into Plone.

Dylan Jay

2013-10-16 14:18:37 UTC

Permalink