No description, website, or topics provided.
CSS Java HTML FreeMarker TeX Shell Other
Permalink
Failed to load latest commit information.
bin Merge pull request #1047 from codyhoag/converter-bat Oct 9, 2014
book Moved book stuff around to accomodate new Discover folder structure. Nov 11, 2015
code LRDOCS-3286 Refer to source folder names instead of ZIP files. Feb 1, 2017
develop Gradle ref doc weekly updates Feb 24, 2017
discover Merge branch 'pull-request-2151-LRDOCS-3365' Feb 24, 2017
distribute LRDOCS-3329 Fix link to API adaptation tutorial Feb 2, 2017
guidelines LRDOCS-3280 updated liferay-docs README and images. Jan 19, 2017
lib LRDOCS-3286 Refer to source folder names instead of ZIP files. Feb 1, 2017
release-notes/images Empty folders. Mar 17, 2015
.directory Added Liferay 7 folders Jan 12, 2016
.gitattributes Added .gitattributes to fix cr/lf stuff. Jul 29, 2013
.gitignore Allow ZIP files to be added to the repo Jul 13, 2016
README.markdown LRDOCS-3280 updated liferay-docs README and images. Jan 19, 2017
build-common.xml Added concat-markdown task and target for book preparation. Nov 5, 2014
build-site-common.xml LRDOCS-3286 Create an Ant target for executing the moved class reporter. Jan 19, 2017
build.properties LRDOCS-1392 Build .METADATA file for the ZIPs Sep 12, 2014
build.xml LRDOCS-3286 Add target compare-portal-source Feb 1, 2017
copyright.txt Misspelling. Nov 15, 2011
docteam-logo.png Removed orphaned images; renamed first configurable tutorial to be the Feb 3, 2016
release-site.properties LRDOCS-3156 Add token for IDE/Developer Studio Dec 1, 2016

README.markdown

LIFERAY-DOCS

Liferay Docs Icon

Join the chat at https://gitter.im/rotty3000/blade

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 easy to 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, Markdown & tools guide, and a tutorial template.

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

Quick Steps to Add a New Article

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:

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

     Branch   Portal Version 
     master   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.

Structure

All Liferay Developer Network articles reside in liferay-docs repository folders that are laid out in a similar manner to LDN's pages and articles. Each repository folder under discover, develop, and distribute represents a section of LDN's articles. For example, the discover/portal folder contains Markdown files and images that are the source for LDN's User & Admin → User Guide articles.

The following tables show the folder locations for articles published to LDN's User & Admin, Developer, and Marketplace sections.

Source Folders for Liferay Developer Network Articles:

User & Admin
 liferay-docs/discover/
 • portal/Portal
 • social-office/Social Office
 • deployment/Deployment
 • reference/Reference
 • new-articles/ (You can submit new articles here for LDN's User & Admin section)
Developer
 liferay-docs/develop/
 • learning-paths/Learning Paths
 • tutorials/Tutorials
 • reference/Reference
 • new-articles/ (You can submit new articles here for LDN's Developer section)
Marketplace
 liferay-docs/distribute/
 • distribute/new-articles/ (You can submit new articles here for LDN's Marketplace section)

Now that you're familiar with the layout of the liferay-docs repository, you may be interested in adding and editing LDN articles in a local copy of the liferay-docs repository.

Working Locally

If you're new to the liferay-docs repository and you want to add/edit material locally, you first must clone the project. For information on how to work with Git projects, see How do I use Git and GitHub?

To add an article to LDN's Develop section (as an example), create your article and its images in the liferay-docs/develop/new-articles folder. Commit your added files and send a pull request to default user liferay. For more information on where to place new articles and for guidelines on writing them, see How do I write and submit my own article?

To modify an article, you can edit it locally in its repository location, in a branch created for that purpose. After you've made your changes, commit them and submit a pull request to the default user liferay.

To preview an article, invoke one of the convert.[bat|sh] scripts on your Markdown file. The scripts are in the bin folder. See How do I convert my local Markdown to HTML using the provided convert scripts? for details on using the script.

You've learned how to contribute and you know the article folder structure. Got questions? Check out the liferay-docs FAQ for answers.

Thanks for helping us out with Liferay documentation!