Documentation, where to focus and help out?

RE: Documentation, where to focus and help out?

2020-12-04T07:42:55Z

Hello All,

Wanted to bump this conversation up again to see if there is any further information on the ability to help or make suggestions for improvement or clarification on the help.liferay.com content. It does seem to be continuing to improve but I continue finding myself wanting to not just hit the buttons that say whether the page was helpful or not, but I want to actually comment on _why_ it was or wasn't helpful.

For example, when going through the exercise of creating custom Finder methods using either Custom SQL or Dynamic Queries, there is a small note that would be helpful to remind developers that the custom Finder methods do (although, maybe obviously) need to be OSGI components also. If a dev doesn't make that FinderImpl a component, mysterious failures seem to ensue.

All in all, grateful for the efforts that are going into the docs, it is much appreciated, just looking for a way to directly comment directly in context over there somehow.

RE: Documentation, where to focus and help out?

2020-04-15T12:36:32Z

Orin Fink:

Awesome. Thanks David for the clarification. Is the new platform open for input / pull requests?

I believe that it will be (but probably isn't yet). There's help.liferay.com, and also in the build-up phase, learn.liferay.com (deliberately not linking both here)

RE: Documentation, where to focus and help out?

2020-04-15T01:32:23Z

Awesome. Thanks David for the clarification. Is the new platform open for input / pull requests?

RE: Documentation, where to focus and help out?

2020-04-14T03:52:35Z

As announced in Devcon 2019, 7.2+ documentation is being rebuilt under a goal-based format on help.liferay.com. While it is not yet complete, the team is working hard to get more documentation published there.

I believe the plan is to keep portal.liferay.dev for 7.2 and earlier versions' documentation.

Documentation, where to focus and help out?

2020-04-13T18:23:02Z

I am a little lost as to where the effort on documentation is being put currently. Is it in the https://help.liferay.com/ Developer Tutorials or is it in the Developer Network (https://portal.liferay.dev/)? (or both, but for different audiences) In either case, where are the relevant Github repos for the documentation so that we can make Pull Requests for each (in case the answer is efforts are being put toward both destinations?