From 6fe88129d1550c517a8e766aac8e1cf7379b2eaf Mon Sep 17 00:00:00 2001 From: Jeff Scheel Date: Wed, 17 Feb 2016 09:51:02 -0600 Subject: [PATCH] Restructure Project to use Docs-Master Project This project has now been built to longer contain common files nor the master POM file and now instead relies on the ../Docs-Master/ structure when building. As such, the doc/common directory was removed and the remaining files in doc/ were promoted to main level. Then, the top POM file was converted to a "minimal" POM referencing the master-pom in ../Docs-Master/. Finally, the template/ directory required a slight update to the POM file (new name for parent minimal POM, "workgroup-pom") and updated locations (../../Docs-Master/common) for the common preface and appendix files in the book file (bk_main.xml). For completeness, the README file was updated to ensure users of the project understand it no longer is self-contained and must rely on the Docs-Master project. Signed-off-by: Jeff Scheel --- README.md | 18 + doc/common/app_foundation.xml | 136 ------ doc/common/app_support.xml | 437 ------------------ doc/common/ch_preface.xml | 12 - doc/common/sec_conventions.xml | 40 -- doc/common/sec_dochistory.xml | 13 - doc/pom.xml | 62 --- pom.xml | 22 + {doc/template => template}/app_template.xml | 0 {doc/template => template}/bk_main.xml | 8 +- {doc/template => template}/ch_example.xml | 0 .../ch_template_overview.xml | 0 .../figures/example_graphic.bmp | Bin .../figures/example_graphic.odg | Bin {doc/template => template}/pom.xml | 2 +- .../sec_template_debugging.xml | 0 .../sec_template_existing_document.xml | 0 .../sec_template_faq.xml | 0 .../sec_template_getting_started.xml | 0 .../sec_template_new_document.xml | 0 .../sec_template_policies.xml | 0 .../sec_template_references.xml | 0 22 files changed, 45 insertions(+), 705 deletions(-) delete mode 100644 doc/common/app_foundation.xml delete mode 100644 doc/common/app_support.xml delete mode 100644 doc/common/ch_preface.xml delete mode 100644 doc/common/sec_conventions.xml delete mode 100644 doc/common/sec_dochistory.xml delete mode 100644 doc/pom.xml create mode 100644 pom.xml rename {doc/template => template}/app_template.xml (100%) rename {doc/template => template}/bk_main.xml (93%) rename {doc/template => template}/ch_example.xml (100%) rename {doc/template => template}/ch_template_overview.xml (100%) rename {doc/template => template}/figures/example_graphic.bmp (100%) rename {doc/template => template}/figures/example_graphic.odg (100%) rename {doc/template => template}/pom.xml (99%) rename {doc/template => template}/sec_template_debugging.xml (100%) rename {doc/template => template}/sec_template_existing_document.xml (100%) rename {doc/template => template}/sec_template_faq.xml (100%) rename {doc/template => template}/sec_template_getting_started.xml (100%) rename {doc/template => template}/sec_template_new_document.xml (100%) rename {doc/template => template}/sec_template_policies.xml (100%) rename {doc/template => template}/sec_template_references.xml (100%) diff --git a/README.md b/README.md index 1ce278c..6830fa7 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,24 @@ OpenPOWER Foundation. The PDF and HTML generated from the doc/template/ directory build a document that both describes how to build a new document and contains examples and directions on how to do it. +To build this project, one must ensure that the Docs-Master project has +also been cloned at the same directory level as the Docs-Template project. +This can be accomplished with the following steps: + +1. Clone this project (Docs-Master) using the following command: +``` +$ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git +``` +2. Clone the documentation project (my_project) using the following command: +``` +$ git clone https://github.com/OpenPOWERFoundation/my_project.git +``` +3. Build the project with these commands: +``` +$ cd Docs-Template +$ mvn clean generate-sources +``` + The online version of the document can be found in the OpenPOWER Foundation Document library at [TBD](http://openpowerfoundation.org/docs) diff --git a/doc/common/app_foundation.xml b/doc/common/app_foundation.xml deleted file mode 100644 index 7e4f9fa..0000000 --- a/doc/common/app_foundation.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - OpenPOWER Foundation overview - - The OpenPOWER Foundation was founded in 2013 as an open technical membership organization - that will enable data centers to rethink their approach to technology. Member companies - are enabled to customize POWER CPU processors and system platforms for optimization and - innovation for their business needs. These innovations include custom systems for large - or warehouse scale data centers, workload acceleration through GPU, FPGA or advanced I/O, - platform optimization for SW appliances, or advanced hardware technology exploitation. - OpenPOWER members are actively pursing all of these innovations and more and welcome - all parties to join in moving the state of the art of OpenPOWER systems design forward. - - - To learn more about the OpenPOWER Foundation, visit the organization website at - openpowerfoundation.org. - - -
- Foundation documentation - Key foundation documents include: - - - - - Bylaws of OpenPOWER Foundation - - - - - - OpenPOWER Foundation Intellectual Property Rights (IPR) Policy - - - - - - OpenPOWER Foundation Membership Agreement - - - - - - OpenPOWER Anti-Trust Guidelines - - - - - More information about the foundation governance can be found at - openpowerfoundation.org/about-us/governance. - -
- -
- Technical resources - Development resouces fall into the following general categories: - - - - - Foundation work groups - - - - - Remote development environments (VMs) - - - - - Development systems - - - - - Technical specifications - - - - - Software - - - - - Developer tools - - - - The complete list of technical resources are maintained on the foundation - Technical Resources web page. - -
- -
- Contact the foundation - To learn more about the OpenPOWER Foundation, please use the following contact points: - - - General information -- info@openpowerfoundation.org - - - - Membership -- membership@openpowerfoundation.org - - - - Technical Work Groups and projects -- tsc-chair@openpowerfoundation.org - - - - Events and other activities -- admin@openpowerfoundation.org - - - - Press/Analysts -- press@openpowerfoundation.org - - - - - - More contact information can be found at - openpowerfoundation.org/get-involved/contact-us. - -
- - diff --git a/doc/common/app_support.xml b/doc/common/app_support.xml deleted file mode 100644 index 590d924..0000000 --- a/doc/common/app_support.xml +++ /dev/null @@ -1,437 +0,0 @@ - - - - Community support - The following resources are available to help you run and use - OpenStack. The OpenStack community constantly improves and - adds to the main features of OpenStack, but if you have - any questions, do not hesitate to ask. Use the - following resources to get OpenStack support, - and troubleshoot your installations. -
- Documentation - For the available OpenStack documentation, see docs.openstack.org. - To provide feedback on documentation, join and use the - openstack-docs@lists.openstack.org - mailing list at OpenStack Documentation Mailing List, or report a bug. - The following books explain how to install an OpenStack - cloud and its associated components: - - - - - Installation Guide for Debian - 7.0 - - - - - - Installation Guide for openSUSE and - SUSE Linux Enterprise Server - - - - - - Installation Guide for Red Hat - Enterprise Linux, CentOS, and - Fedora - - - - - - Installation Guide for Ubuntu 14.04 - (LTS) - - - - The following books explain how to configure and run an - OpenStack cloud: - - - Architecture Design - Guide - - - - Cloud Administrator - Guide - - - Configuration - Reference - - - Operations - Guide - - - High Availability - Guide - - - Security - Guide - - - Virtual Machine Image - Guide - - - The following books explain how to use the OpenStack - dashboard and command-line clients: - - - - API Quick - Start - - - - End User - Guide - - - - Admin User - Guide - - - - Command-Line Interface - Reference - - - The following documentation provides reference and - guidance information for the OpenStack APIs: - - - OpenStack API Complete - Reference (HTML) - - - API Complete Reference (PDF) - - - OpenStack Block Storage - Service API v2 - Reference - - - OpenStack Compute API v2 and - Extensions - Reference - - - OpenStack Identity Service API - v2.0 Reference - - - OpenStack Image Service API v2 - Reference - - - OpenStack Networking API v2.0 - Reference - - - OpenStack Object Storage API - v1 Reference - - - The Training Guides - offer software training for cloud administration and - management. -
-
- ask.openstack.org - During the set up or testing of OpenStack, you might - have questions about how a specific task is completed or - be in a situation where a feature does not work correctly. - Use the ask.openstack.org site to ask questions and - get answers. When you visit the http://ask.openstack.org site, scan the - recently asked questions to see whether your question has - already been answered. If not, ask a new question. Be sure - to give a clear, concise summary in the title and provide - as much detail as possible in the description. Paste in - your command output or stack traces, links to screen - shots, and any other information which - might be useful. -
-
- OpenStack mailing lists - A great way to get answers and insights is to post your - question or problematic scenario to the OpenStack mailing - list. You can learn from and help others who might have - similar issues. To subscribe or view the archives, go to - http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack. - You might be interested in the other mailing lists for - specific projects or development, which you can find on - the wiki. A description of all mailing lists is - available at http://wiki.openstack.org/MailingLists. -
-
- The OpenStack wiki - The OpenStack - wiki contains a broad range of topics but some of the - information can be difficult to find or is a few pages deep. - Fortunately, the wiki search feature enables you to search by title - or content. If you search for specific information, such as about - networking or nova, you can find a large amount of relevant - material. More is being added all the time, so be sure to check back - often. You can find the search box in the upper-right corner of any - OpenStack wiki page. -
-
- The Launchpad Bugs area - The OpenStack community values your set up and testing efforts and - wants your feedback. To log a bug, you must sign up for a Launchpad - account at https://launchpad.net/+login. You can view existing bugs - and report bugs in the Launchpad Bugs area. Use the search feature - to determine whether the bug has already been reported or already - been fixed. If it still seems like your bug is unreported, fill out - a bug report. - Some tips: - - - Give a clear, concise summary. - - - Provide as much detail as possible in the - description. Paste in your command output or stack - traces, links to screen shots, and any - other information which might be useful. - - - Be sure to include the software and package - versions that you are using, especially if you are - using a development branch, such as, - "Juno release" vs git commit - bc79c3ecc55929bac585d04a03475b72e06a3208. - - - Any deployment-specific information is helpful, such as - whether you are using Ubuntu 14.04 or are performing a - multi-node installation. - - - The following Launchpad Bugs areas are available: - - - - Bugs: OpenStack Block Storage - (cinder) - - - Bugs: OpenStack Compute (nova) - - - Bugs: OpenStack Dashboard - (horizon) - - - Bugs: OpenStack Identity - (keystone) - - - Bugs: OpenStack Image Service - (glance) - - - Bugs: OpenStack Networking - (neutron) - - - Bugs: OpenStack Object Storage - (swift) - - - - Bugs: Bare Metal (ironic) - - - Bugs: Data Processing Service - (sahara) - - - Bugs: Database Service (trove) - - - Bugs: Orchestration (heat) - - - Bugs: Telemetry (ceilometer) - - - Bugs: Queue Service (marconi) - - - - Bugs: OpenStack API Documentation - (developer.openstack.org) - - - Bugs: OpenStack Documentation - (docs.openstack.org) - - -
-
- The OpenStack IRC channel - The OpenStack community lives in the #openstack IRC channel on the - Freenode network. You can hang out, ask questions, or get immediate - feedback for urgent and pressing issues. To install an IRC client or - use a browser-based client, go to http://webchat.freenode.net/. You can also use Colloquy - (Mac OS X, http://colloquy.info/), mIRC (Windows, http://www.mirc.com/), - or XChat (Linux). When you are in the IRC channel and want to share - code or command output, the generally accepted method is to use a - Paste Bin. The OpenStack project has one at http://paste.openstack.org. Just paste your longer - amounts of text or logs in the web form and you get a URL that you - can paste into the channel. The OpenStack IRC channel is - #openstack on - irc.freenode.net. You can find a list of all - OpenStack IRC channels at https://wiki.openstack.org/wiki/IRC. -
-
- Documentation feedback - To provide feedback on documentation, join and use the - openstack-docs@lists.openstack.org mailing list at - OpenStack - Documentation Mailing List, or report a bug. -
-
- OpenStack distribution packages - The following Linux distributions provide - community-supported packages for OpenStack: - - - Debian: - http://wiki.debian.org/OpenStack - - - CentOS, Fedora, and Red - Hat Enterprise Linux: - http://openstack.redhat.com/ - - - openSUSE and SUSE Linux - Enterprise Server: - http://en.opensuse.org/Portal:OpenStack - - - Ubuntu: - https://wiki.ubuntu.com/ServerTeam/CloudArchive - - -
- diff --git a/doc/common/ch_preface.xml b/doc/common/ch_preface.xml deleted file mode 100644 index 1b01521..0000000 --- a/doc/common/ch_preface.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - Preface - - - - - diff --git a/doc/common/sec_conventions.xml b/doc/common/sec_conventions.xml deleted file mode 100644 index 4a02019..0000000 --- a/doc/common/sec_conventions.xml +++ /dev/null @@ -1,40 +0,0 @@ - -
- - Conventions - The OpenPOWER Foundation documentation uses several typesetting conventions. - - Notices - Notices take these forms: - - A handy tip or reminder. - - - Something you must be aware of before proceeding. - - - Critical information about the risk of data loss or security issues. - - - - Command prompts - - - $ prompt - - Any user, including the root user, can run commands that are - prefixed with the $ prompt. - - - - # prompt - - The root user must run commands that are prefixed with the - # prompt. You can also prefix these commands with the - sudo command, if available, to run them. - - - - -
diff --git a/doc/common/sec_dochistory.xml b/doc/common/sec_dochistory.xml deleted file mode 100644 index 8ece017..0000000 --- a/doc/common/sec_dochistory.xml +++ /dev/null @@ -1,13 +0,0 @@ - -
- Document change history - - This version of the guide replaces and obsoletes all earlier versions. - The following table describes the most recent changes: - - -
diff --git a/doc/pom.xml b/doc/pom.xml deleted file mode 100644 index 4aeee6a..0000000 --- a/doc/pom.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - 4.0.0 - - org.openpowerfoundation.docs - - parent-pom - 1.0.0-SNAPSHOT - pom - - - - template - - - - OpenPOWER Foundation Repositories - - true - - - - openpower-foundation - OpenPOWER Foundation Repository - http://openpowerfoundation.org/repo.openpowerfoundation.org/ - - - - - - - openpower-foundation - OpenPOWER Foundation Repository - http://openpowerfoundation.org/repo.openpowerfoundation.org/ - - - - - - - - - - - org.openpowerfoundation.docs - - openpowerdocs-maven-plugin - - - - - - diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..0f2816e --- /dev/null +++ b/pom.xml @@ -0,0 +1,22 @@ + + + + + org.openpowerfoundation.docs + master-pom + 1.0.0-SNAPSHOT + ../Docs-Master/pom.xml + + 4.0.0 + + workgroup-pom + pom + + + + template + + diff --git a/doc/template/app_template.xml b/template/app_template.xml similarity index 100% rename from doc/template/app_template.xml rename to template/app_template.xml diff --git a/doc/template/bk_main.xml b/template/bk_main.xml similarity index 93% rename from doc/template/bk_main.xml rename to template/bk_main.xml index b3ef126..8543563 100644 --- a/doc/template/bk_main.xml +++ b/template/bk_main.xml @@ -92,17 +92,17 @@ - + - - + + - + diff --git a/doc/template/ch_example.xml b/template/ch_example.xml similarity index 100% rename from doc/template/ch_example.xml rename to template/ch_example.xml diff --git a/doc/template/ch_template_overview.xml b/template/ch_template_overview.xml similarity index 100% rename from doc/template/ch_template_overview.xml rename to template/ch_template_overview.xml diff --git a/doc/template/figures/example_graphic.bmp b/template/figures/example_graphic.bmp similarity index 100% rename from doc/template/figures/example_graphic.bmp rename to template/figures/example_graphic.bmp diff --git a/doc/template/figures/example_graphic.odg b/template/figures/example_graphic.odg similarity index 100% rename from doc/template/figures/example_graphic.odg rename to template/figures/example_graphic.odg diff --git a/doc/template/pom.xml b/template/pom.xml similarity index 99% rename from doc/template/pom.xml rename to template/pom.xml index c98dd60..1da48cf 100644 --- a/doc/template/pom.xml +++ b/template/pom.xml @@ -5,7 +5,7 @@ org.openpowerfoundation.docs - parent-pom + workgroup-pom 1.0.0-SNAPSHOT ../pom.xml diff --git a/doc/template/sec_template_debugging.xml b/template/sec_template_debugging.xml similarity index 100% rename from doc/template/sec_template_debugging.xml rename to template/sec_template_debugging.xml diff --git a/doc/template/sec_template_existing_document.xml b/template/sec_template_existing_document.xml similarity index 100% rename from doc/template/sec_template_existing_document.xml rename to template/sec_template_existing_document.xml diff --git a/doc/template/sec_template_faq.xml b/template/sec_template_faq.xml similarity index 100% rename from doc/template/sec_template_faq.xml rename to template/sec_template_faq.xml diff --git a/doc/template/sec_template_getting_started.xml b/template/sec_template_getting_started.xml similarity index 100% rename from doc/template/sec_template_getting_started.xml rename to template/sec_template_getting_started.xml diff --git a/doc/template/sec_template_new_document.xml b/template/sec_template_new_document.xml similarity index 100% rename from doc/template/sec_template_new_document.xml rename to template/sec_template_new_document.xml diff --git a/doc/template/sec_template_policies.xml b/template/sec_template_policies.xml similarity index 100% rename from doc/template/sec_template_policies.xml rename to template/sec_template_policies.xml diff --git a/doc/template/sec_template_references.xml b/template/sec_template_references.xml similarity index 100% rename from doc/template/sec_template_references.xml rename to template/sec_template_references.xml