Modify Documentation

Contains information about how to add and modify iota documentation that is part of the iota source tree. This documentation is written in asciidoc.

Source

Documents do not include version information as part of the file name.

Source Location

Document	Source Format	Source Tree	Output Format
Installation Guide	asciidoc	docs/install/	Web Book, PDF

Source Tree Organization

All documents share a common web-book style sheet definition, which is located in docs/css/iota-manuals.css.

The source tree for each manual is organized as follows:

File/Directory	Content
`pom.xml`	Maven Project Object Model (POM) used to build the document.
`src/`	The source files used to define the document.
`src/asciidoc`	Asciidoc files for the document.
`src/asciidoc/index.adoc`	Main asciidoc defining the document. Includes the different chapters from the `_chapters` directory.
`src/asciidoc/_chapters/`	Source files for the different chapters in the document.
`images/`	Images used in the document.
`resources/`	Other include materials; for example, source examples that are included with the document.
`target/`	Build output directory. Contains the web book, the PDF file, and supporting directories.
`target/index.pdf`	Generated PDF version of the document.
`target/images/`	Copy of the `images/` directory.
`target/resources/`	Copy of the `resources/` directory.
`target/site/`	Generated web-book directory.
`target/site/index.html`	Generated web book.
`target/site/css/`	Style sheets related to the web book. The common style sheet is included in the index.html file.
`target/site/images/`	Copy of the `images/` directory.
`target/site/resources/`	Copy of the `resources/` directory.

Making Changes

Please refer to the following web sites for guidance for information about working on asciidoc-based documentation.

Once you’ve made the desired changes, then do the following:

Building an Individual Document

Be sure to source env.sh, so that the IOTA_VER environment variable is defined.
Build the document using mvn clean site in the directory containing the document; for example: docs/install.
Verify the content in the generated target directory.
1. The target/index.html file provides the entry point for the web book.
2. For those that have API documentation, the target/apidocs/index.html file is the entry point.
3. For those that have PDF, the target/index.pdf file contains the PDF version of the document.

Building the Entire Website, including Documents

Be sure to source env.sh, so that the IOTA_VER environment variable is defined.
Build everything using mvn clean post-site in the top-level directory.
Verify the contents in the generated docs/target directory.
1. All documents are in docs/target/docs directory.

Build iota Document Tree

The external version of the iota Document Tree is published to http://iota.incubator.apache.org/docs. Please refer to Publish below.

The build version of the iota Document Tree is located in docs/target/docs, which is created when you build the iota web site in Maven.

Version Directories

The iota Document Tree consists of Version Directories:

Version Directory	Content	Web Site Directory
`latest`	Known place for the latest version of a document.	`iota.incubator.apache.org/docs/<document-name>`
`<version>`	Release-specific version of a document.	`iota.incubator.apache.org/docs/<version>/<document-directory>`

latest: Provides a well-known place for each document. This practice makes it possible to link to a document in instructional text, web sites, and other documents.
<version>: Provides per-release versions of documents. Previous versions are kept in the web site’s SVN repository ensuring that N versions of the documentation are available.

Document Directories

Each document is placed in its own Document Directory:

Document	Document Directory Name
Installation Guide	`cinstall`

The Document Directories are organized as follows. Files and sub-directories may or may not be present in the Document Directory depending on document.

File/Directory	Content
`*.pdf`	The PDF version of the document. For example, `iota_install_Guide.pdf`.
`index.html`	The web book version of the document. Generated by asciidoc.
`apidocs`	API documentation provided as a web book. Generated by javadoc.
`apidocs/index.html`	Entry point for API documentation. Generated by javadoc.
`css`	CSS definitions used by the web-version of the document. Populated by asciidoc.
`images`	Images used by the web-version of the document. Populated by asciidoc.
`resources`	Resource files referenced for source download etc. Populated by asciidoc.

The Document Directories are copied under the Version Directories thereby creating the web-accessible iota document tree.

Publish

Publication is done when a committer is ready to update the external web site. You do not perform these steps as part of checking in changes. Publishing steps are documented in Committer Workflow.

Space shortcuts

Page tree