OpenPOWER Library

 1.3.2.3. Copying the Document Development Guide as a new document framework

Instead of copying an existing document, you may want to start with the Document Development Guide (Doces-Template) source. The steps to do this are similar to those above, but with a few more commands. The following commands will create a new document based on this guide:

  1. Navigate down to your project directory, called my_project for this example. This can be achieved using the cd command:

    $ cd ~/my_project
    $ 

    This directory should contain any existing document folders along with at least a pom.xml file, a LICENSE file, and a README.md file.

  2. Clone the the Documentation Development Guide (Docs-Template) project into your working directory with this command:

    $ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git
    Cloning into 'Docs-Template'...
    remote: Counting objects: 163, done.
    remote: Total 163 (delta 0), reused 0 (delta 0), pack-reused 163
    Receiving objects: 100% (163/163), 275.60 KiB | 0 bytes/s, done.
    Resolving deltas: 100% (96/96), done.
    Checking connectivity... done.
    $ 
  3. To create a new project directory, simply create a new directory and copy the contents of the Docs-Template/doc_dev_guide directory. If creating a new project named my_doc via a command line, the command sequence would look like this:

    $ mkdir my_doc
    $ cp -r Docs-Template/doc_dev_guide/* my_doc
    $ 
  4. Once copied, the Docs-Template directory and all its contents should be removed from your project so that it does not accidentally get included in your project. The command rm -rf Docs-Template

  5. Finally, add the new project to the Workgroup POM file (my_project/pom.xml). Using your editor, add the following lines between the <modules> and the </modules> tags near the top of the file:

    <module>my_doc</module>
      
[Note]Note

Before committing the project back to git, you will need to add the new directory to the git repository. This can be performed using the git add my_doc/ command on the whole directory.

You are now ready to begin making updates to your new document. Continue with the next step in Creating a new document.


loading table of contents...