Slack Status

Welcome to Liferay's official documentation project, the home of Liferay Developer Network articles. All articles are written in Markdown, making them easy to write and read. Approved articles are uploaded to the Liferay Developer Network (LDN) and converted automatically to HTML. In this project, you can contribute new articles, improve existing articles, or fix documentation bugs. To produce documentation that is comprehensive and stylistically consistent, the liferay-docs project provides writing guidelines, standards & customizations, and a tutorial template.

You'll learn how quickly to submit a new article and its images next.

You can follow these steps to create a new article and contribute it from GitHub.

1. Sign in to GitHub. If you don't already have a GitHub account, you must join GitHub in order to contribute to liferay-docs.

2. Click on a new-articles link folder below. These match the LDN sections where you can add a articles:

   • develop/new-articles

   • discover/new-articles

   • distribute/new-articles

3. Select the liferay-docs branch that matches the Liferay Portal version you're writing about:

   Branch Portal Version
   master 7.2
   7.1.x 7.1
   7.0.x 7.0
   6.2.x 6.2

4. Click the plus sign after new-articles/: new articles folder

5. Write your article and click the Propose new file button, to prepare a pull request.

6. Send the pull request to the default user liferay.

7. Drag your article's images into the pull request's comments to associate the images with your article.

Your new article is submitted! Liferay's Knowledge Management team will review your contribution. Approved changes are merged into the liferay-docs repo and published to the Liferay Developer Network.

If you want to clone our repository and do serious documentation work on your own machine, click here to go to our guidelines section.

Thanks for helping us out with Liferay documentation!

cd liferay-docs
./bin/update_liferay_learn_links.sh path/to/properties/file

For example,

cd liferay-learn
cat ./site/docs/redirects_keep.properties ./site/docs/redirects_new.properties > ~/redirects.properties
cd ../liferay-docs
./bin/update_liferay_learn_links.sh ~/redirects.properties