Argh..... 2013/9/4 Christian Grobmeier <[email protected]>: > When I first looked at Struts, the website was a mess. It still is (but > we're working on it). I was confused by countless topics. It is in my > genes to look at the source code immediately, but the Struts sources > were huge. Unfortunately i was not able to connect documentation to the > source code.
Sometime ago someone did start working on the new User Guide http://struts.apache.org/development/2.x/docs/user-guide.html > I started with the JSON plugin first and got this: > http://struts.apache.org/release/2.3.x/struts2-plugins/struts2-json-plugin/index.html > > which is an empty page. I looked into the source code and was not > quickly able to find out whats going on. > > Then I found some docs in the wiki. But the correlation of Struts > documentation to the wiki and static webpages is black magic. Honestly, > if I couldn't ask you (Lukasz) I would still not know how these things > are all tied. And believe me, I am going to continue to ask you on it. There is no correlation :-) Basically what is under /docs is exported from Confluence /WW - so we have a dualism here ;-) It would be cool to have everything in one place - webpage and docs either in Confluence or as webpages (i.e. Markdown) > This is a huge help for others: > http://struts.apache.org/helping.html > > But I believe given our huge website its hard to find. It says how I > create a patch and how join the mailing list. But thats not enough in > the Struts case. I would love detailled, easy to understand instructions > how a non-committer can fix typos on our docs in less then a minute. I > mean instructions which you don't need to search. I think we'll need to > explain how we are building things. Many of the informations are outdated and can overwhelm users - I don't like to read half of page to at the end perform mvn release:perform ;-) I mostly like our release guideline, yet still outdated but it tells you step-by-step what to do. 'Why' is less important on the beginning. http://struts.apache.org/development/2.x/docs/building-struts-2-normal-release.html > I think we should make things like > this page: > > https://cwiki.apache.org/confluence/display/WW/Struts+Next > > more prominent. We should also explain what we would do when we start > working on v2.5 (do we create a branch? do we just commit to the trunk? > and so on). There is one problem with that - why did you ask beforehand? If you don't know something, please ask - then I can answer or update docs or something else. The main problem here is I don't know if something is missing, for me some informations are obvious. To be more specific and answer your question: we will figure it out and discuss when we will switch to Git and start working on 2.5. I don't like to prepare huge plans for the future - be agile, adjust, change, go ahead ;-) > When I go to Commons I don't have such problems. I check out a small > component and send in a patch. If I am doing it wrong, somebody tells > me. But in Struts land everything is so huge. > > For me it is all with a better documented workflow and better websites. Good point! Is http://struts.apache.org/helping.html worth extending/simplifying and exposing on the main page? Regards -- Łukasz + 48 606 323 122 http://www.lenart.org.pl/ --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
