From 0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 16 Oct 2020 13:09:11 +0100 Subject: Remove apex asciidoc documents Apex documentation has now all been ported to use the ONAP recommended rst format. This review removes the old asciidoc documents. Issue-ID: POLICY-2824 Change-Id: I562bd344cb7d6ff36e7d54bdb8f95e3b656468f8 Signed-off-by: liamfallon --- src/site-docs/adoc/fragments/howto-build/site.adoc | 93 ---------------------- 1 file changed, 93 deletions(-) delete mode 100644 src/site-docs/adoc/fragments/howto-build/site.adoc (limited to 'src/site-docs/adoc/fragments/howto-build/site.adoc') diff --git a/src/site-docs/adoc/fragments/howto-build/site.adoc b/src/site-docs/adoc/fragments/howto-build/site.adoc deleted file mode 100644 index 6ec453c9e..000000000 --- a/src/site-docs/adoc/fragments/howto-build/site.adoc +++ /dev/null @@ -1,93 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Build APEX Site - -The APEX Maven build comes with full support to build a web site using Maven Site. -Use Maven to build the APEX Site. -Stage the APEX web site. -The target folder for the staged site is - -- Unix: `/usr/local/src/apex/target/ad-site` -- Windows: `C:\dev\apex\target\ad-site` -- Cygwin: `/cygdrive/c/dev/apex/target/ad-site` - -Once the web site is staged, copy the full site to a folder of choice or into a web server. - - -[IMPORTANT] -.Building a Site takes Time -==== -Building and staging the APEX web site can take very long. -The stand-alone documentation will take about 2 minutes. -The sites for all modules and projects and the main APEX site can take between 10-30 minutes depending on your build machine -(~10 minutes without generating source and test-source reports, closer to 30 minutes with all reports). -==== - - -Start the build deleting the staging directory that might have been created by a previous site build. -Then go to the APEX packaging directory. - -[width="100%",options="header",cols="5a,5a,5a"] -|==================== -| Unix | Windows | Cygwin -| -[source%nowrap,sh] ----- -cd /usr/local/src/apex -rm -fr target/ad-site ----- -| -[source%nowrap,bat] ----- -c: -cd \dev\apex -rmdir /s /q target\ad-site ----- -| -[source%nowrap,sh] ----- -cd /cygdrive/c/dev/apex -rm -fr target/ad-site ----- -|==================== - -the workflow for building a complete site then is as follows: - -[source%nowrap,sh] ----- -mvn clean -DapexAll #<1> -mvn install -DskipTests #<2> -mvn generate-resources -N -DapexDocs #<3> -mvn initialize site:attach-descriptor site site:stage -DapexSite #<4> ----- -. First clean all modules to remove any site artifacts, use the _apexXtext_ profile to make sure these modules are processed as well -. Next run a simple install without tests -. Now generate the APEX stand -alone documentation, they are in the local package only so we can use the _-N_ switch -. Last build the actual sites and stage (copy to the staging directory) with the profile _apexSite_ (do not forget the initialize goal, otherwise the staging directory will not be correctly set and sites are staged in every model in a directory called `docs`). - -If you want to build the site for a particular project for testing, the Maven command is simpler. -Since only the main project has APEX documentation (stand-alone), you can use Maven as follow. - -[source%nowrap,sh] ----- -mvn clean site -DapexSite ----- - -If you want to stage the tested site, then use - -[source%nowrap,sh] ----- -mvn clean initialize site:attach-descriptor site site:stage -DapexSite ----- - -- cgit 1.2.3-korg