isabella232 / web-dev-external-docs

Liferay.com Documentation and Guidelines

Easy guides for content authors making changes to Liferay.com

For adding docs to our external site

Feature List: https://trello.com/b/ft2uFMNq/lrdcom-external-docs

Table of Contents

1. Setting Up
2. Creating/Updating Docs
3. Writing Docs Instructions and Guidelines

Setting Up

1. Run npm install on the root to install all dependencies.
2. Run npm start and head to http://localhost:8000

It's now watching for changes through Gulp.

Creating/Updating Docs

1. Make sure gulp is running. See Setting Up.
2. Make changes in /src
3. Add, commit, and push changes to git.

Changes should reflect on the live site in a few minutes.

Images

To add images just use plain ol' HTML and put the images in the same directory as the file. <img src="my-image-in-the-same-directory.jpg" />

Adding Screenshots

To leverage screenshot zooming feature, wrap your content in screenshot block with the src attribute as source of the image.

<screenshot src="case-studies-upload-3.png" />
    1. Log in to Lifereay
</screenshot>

Writing Instructions and Guidelines

Instructions

1. Make a new .md file in the proper folder and write up your documentation there following our guidelines
2. Send a PR to team member for peer-review and let them merge changes.

If change is significant, Submit to Liferay's copyrighters for readability and then communicate with marketing stakeholders that a change has been made.

General Rules

1. Need an h1 for Title. Break up sections by h2. This ensures page title and sectioning is done accurately

Great resources:

• https://jacobian.org/writing/great-documentation/