Details

    • Type: Technical Task
    • Status: Closed
    • Priority: Minor
    • Resolution: Completed
    • Affects Version/s: None
    • Fix Version/s: Master
    • Component/s: None
    • Labels:
      None

      Description

      This task involves publishing the Portlet 3.0 API Javadoc at docs.liferay.com

      Instructions

      1. Clone the Apache Pluto Git repo

      git clone https://github.com/apache/portals-pluto.git
      

      2. Build Apache Pluto

      cd portals-pluto
      mvn clean install
      

      3. Generate the plain (non-color-coded) javadoc and rename the generated folder name

      cd portlet-api
      mvn javadoc:javadoc
      mv target/site/apidocs target/site/javadocs
      

      4. Generate the color-coded javadoc and rename the generated folder name

      mvn -Djavadoc.css.file=portlet-api.css javadoc:javadoc
      mv target/site/apidocs target/site/javadocs-changes
      

      5. Add the "Switch to Color Coded Version" hyperlink:

      sed -e 's/h1>/h1>(<a href="..\/javadocs-changes\/index.html" target="_top">Switch to Color-Coded Version<\/a>)/g' \
          target/site/javadocs/overview-summary.html > target/temp.html
      mv target/temp.html target/site/javadocs/overview-summary.html
      

      6. Add the "Switch to Plain Version" hyperlink:

      sed -e 's/h1>/h1>(<a href="..\/javadocs\/index.html" target="_top">Switch to Plain Version<\/a>)/g' \
          target/site/javadocs-changes/overview-summary.html > target/temp.html
      mv target/temp.html target/site/javadocs-changes/overview-summary.html
      

      7. Publish the target/site/javadoc folder to https://docs.liferay.com/portlet-api/3.0/javadocs

      8. Publish the target/site/javadoc-changes folder to https://docs.liferay.com/portlet-api/3.0/javadocs-changes

        Attachments

          Activity

            People

            Assignee:
            neil.griffin Neil Griffin
            Reporter:
            neil.griffin Neil Griffin
            Recent user:
            Brian Chan
            Participants of an Issue:
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Days since last comment:
              2 years, 45 weeks, 3 days ago

                Packages

                Version Package
                Master