Forums

Home » Liferay Documentation

Combination View Flat View Tree View
Threads [ Previous | Next ]
toggle
Jan Hájovský
Best way of logging RFEs for Liferay documentation
July 24, 2013 1:42 AM
Answer

Jan Hájovský

Rank: New Member

Posts: 1

Join Date: May 22, 2013

Recent Posts

Hi,

could you advice, what is the best way of logging RFEs for Liferay documentation? I logged the following against Liferay documentation for version 6.1: http://issues.liferay.com/browse/LPS-37195. I'm not getting a reaction for it. I'm possibly doing a mistake in the way I'm reporting it. Should I perhaps report the issue against 6.2 documentation, so it gets attention?

Best regards, Jan
Tomas Polesovsky
RE: Best way of logging RFEs for Liferay documentation
July 24, 2013 1:20 PM
Answer

Tomas Polesovsky

LIFERAY STAFF

Rank: Liferay Master

Posts: 611

Join Date: February 13, 2009

Recent Posts

Hi Jan,

I believe the best way is to directly send a pull request to https://github.com/liferay/liferay-docs

Sincerely,
-- tom
Richard Sezov
RE: Best way of logging RFEs for Liferay documentation
July 25, 2013 9:31 AM
Answer

Richard Sezov

LIFERAY STAFF

Rank: Regular Member

Posts: 205

Join Date: February 7, 2007

Recent Posts

Hi Jan,

Right now, you've identified a hole in our communication process. We have an LRDOCS project, but right now it's not public. We're working to turn it into a public project, and then you'll be able to enter tickets for the documentation directly.

Thanks for adding this one and for posting here (I'm subscribed to this category). I'll make sure we get to it.

--Rich
Denis Signoretto
RE: Best way of logging RFEs for Liferay documentation
January 7, 2014 1:22 AM
Answer

Denis Signoretto

Rank: Expert

Posts: 261

Join Date: April 21, 2009

Recent Posts

Hi Richard,

I've seen LRDOCS project it's now a public project. I think it's a good choice.
At the moment documentation RFEs opened in Community Feature Ideas are collected in LPS Documentation component.
IMHO, it shouldn't be better create issues in LRDOCS project ?

WDYT ?

Best Regards,
Denis.

P.S. About Documentation component I think it should mantained for complementary Documentation like dtd and properties files descriptions, XML comments, javadocs and so on.
Richard Sezov
RE: Best way of logging RFEs for Liferay documentation
January 7, 2014 11:35 AM
Answer

Richard Sezov

LIFERAY STAFF

Rank: Regular Member

Posts: 205

Join Date: February 7, 2007

Recent Posts

Hey, no fair! You noticed before I had a chance to blog about it (just joking)! emoticon

The way we're working it out, the LPS Documentation component is for reference docs: Javadoc, AlloyUI reference, tag docs, properties docs, etc. The formal, written documentation is covered by the LRDOCS project. So if you see something missing from the User Guide or the Developer Guide, or if you find a bug or something, it should go to LRDOCS. We're still making some changes to LRDOCS to streamline ticket creation, but it is available now to the community.

I'll blog on this at greater length; but this is the way we're thinking right now. Do you think this will work?

--Rich
Denis Signoretto
RE: Best way of logging RFEs for Liferay documentation
January 7, 2014 11:17 PM
Answer

Denis Signoretto

Rank: Expert

Posts: 261

Join Date: April 21, 2009

Recent Posts

Richard Sezov:
Hey, no fair! You noticed before I had a chance to blog about it (just joking)! emoticon

The way we're working it out, the LPS Documentation component is for reference docs: Javadoc, AlloyUI reference, tag docs, properties docs, etc. The formal, written documentation is covered by the LRDOCS project. So if you see something missing from the User Guide or the Developer Guide, or if you find a bug or something, it should go to LRDOCS. We're still making some changes to LRDOCS to streamline ticket creation, but it is available now to the community.

I'll blog on this at greater length; but this is the way we're thinking right now. Do you think this will work?

--Rich


Hi Richard,

I think this is the right way, and giving community the opportunity to contribute to LRDOCS can improve the revision (and contribution) process.

My only dubt it's related to misusage of LPS Documentation by comunity members.
Looking at issues in LPS Documentation we can find issues related to both LRDOCS and LPS Documentation.

What do you think about using a slifhtly differenent name for LPS Documentation (e.g. Reference Documentation) ?
The idea, as a final result, is to enable two distinct RFEs labels in Community Liferay Ideas: "Reference Documentation" (reporting to LPS project) and "Documentation" (reporting to LRDOCS).

I'll wait for your blog ;)

Thanks,
Denis