Switch branches/tags
simpleapp-archetype-2.0.0-M1 simpleapp-archetype-2.0.0-M1-RC1 rel/todoapp-archetype-1.7.0 rel/todoapp-archetype-1.6.0 rel/simpleapp-archetype-2.0.0-M1 rel/simpleapp-archetype-1.16.2 rel/simpleapp-archetype-1.16.1 rel/simpleapp-archetype-1.16.0 rel/simpleapp-archetype-1.15.1 rel/simpleapp-archetype-1.15.0 rel/simpleapp-archetype-1.14.0 rel/simpleapp-archetype-1.13.2.1 rel/simpleapp-archetype-1.13.2 rel/simpleapp-archetype-1.13.1 rel/simpleapp-archetype-1.13.0 rel/simpleapp-archetype-1.12.2 rel/simpleapp-archetype-1.12.1 rel/simpleapp-archetype-1.12.0 rel/simpleapp-archetype-1.11.1 rel/simpleapp-archetype-1.11.0 rel/simpleapp-archetype-1.10.0 rel/simpleapp-archetype-1.9.0 rel/simpleapp-archetype-1.8.0 rel/simpleapp-archetype-1.7.0 rel/simpleapp-archetype-1.6.0 rel/simple_wicket_restful_jdo-archetype-1.5.0 rel/simple_wicket_restful_jdo-archetype-1.4.1 rel/simple_wicket_restful_jdo-archetype-1.4.0 rel/simple_wicket_restful_jdo-archetype-1.3.0 rel/quickstart_wicket_restful_jdo-archetype-1.5.0 rel/quickstart_wicket_restful_jdo-archetype-1.4.1 rel/quickstart_wicket_restful_jdo-archetype-1.4.0 rel/quickstart_wicket_restful_jdo-archetype-1.3.0 rel/quickstart_wicket_restful_jdo-archetype-1.0.3 rel/quickstart_wicket_restful_jdo-archetype-1.0.2 rel/quickstart_wicket_restful_jdo-archetype-1.0.1 rel/quickstart_wicket_restful_jdo-archetype-1.0.0 rel/isis-viewer-wicket-1.7.0 rel/isis-viewer-wicket-1.6.0 rel/isis-viewer-wicket-1.5.0 rel/isis-viewer-wicket-1.4.1 rel/isis-viewer-wicket-1.4.0 rel/isis-viewer-wicket-1.3.0 rel/isis-viewer-wicket-1.2.0 rel/isis-viewer-wicket-1.1.0 rel/isis-viewer-wicket-1.0.0 rel/isis-viewer-restfulobjects-2.3.0 rel/isis-viewer-restfulobjects-2.2.0 rel/isis-viewer-restfulobjects-2.1.0 rel/isis-viewer-restfulobjects-2.0.0 rel/isis-viewer-restfulobjects-1.0.0 rel/isis-security-shiro-1.5.0 rel/isis-security-shiro-1.4.0 rel/isis-security-shiro-1.3.0 rel/isis-security-shiro-1.1.1 rel/isis-security-shiro-1.1.0 rel/isis-security-shiro-1.0.0 rel/isis-security-file-1.4.0 rel/isis-security-file-1.0.1 rel/isis-security-file-1.0.0 rel/isis-objectstore-jdo-1.5.0 rel/isis-objectstore-jdo-1.4.1 rel/isis-objectstore-jdo-1.4.0 rel/isis-objectstore-jdo-1.3.0 rel/isis-objectstore-jdo-1.1.0 rel/isis-objectstore-jdo-1.0.0 rel/isis-2.0.0-M1 rel/isis-1.16.2 rel/isis-1.16.1 rel/isis-1.16.0 rel/isis-1.15.1 rel/isis-1.15.0 rel/isis-1.14.0 rel/isis-1.13.2 rel/isis-1.13.1 rel/isis-1.13.0 rel/isis-1.12.2 rel/isis-1.12.1 rel/isis-1.12.0 rel/isis-1.11.1 rel/isis-1.11.0 rel/isis-1.10.0 rel/isis-1.9.0 rel/isis-1.8.0 rel/isis-1.7.0 rel/isis-1.6.0 rel/isis-1.5.0 rel/isis-1.4.0 rel/isis-1.3.0 rel/isis-1.2.0 rel/isis-1.1.0 rel/isis-1.0.0 rel/isis-0.2.0-incubating rel/isis-0.1.2-incubating rel/helloworld-archetype-2.0.0-M1 rel/helloworld-archetype-1.16.2 rel/helloworld-archetype-1.16.1 rel/helloworld-archetype-1.16.0 rel/helloworld-archetype-1.15.1 rel/helloworld-archetype-1.15.0
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
src/main
.gitignore
Gemfile
Gemfile.lock
README.adoc
addanchor.groovy
check-bookmarks.sh
check-includes.sh
edit.sh
pom-pdf.xml
pom.xml
preview-html.sh
preview-pdf.sh
publish.sh

README.adoc

Apache Isis

This directory contains the source documentation that constitutes both the Apache Isis' documentation (meaning the website and the users' guide, the reference guide and contributors' guide) It is written using Asciidoc, specifically the Asciidoctor implementation.

The website is created by running build tools (documented below) which create the HTML version of the site and guides. You can therefore easily check the documentation before raising a pull request

So, if you want to contribute documentation - either just to fix a typo, or to write a how-to or longer article - then fork the repo, write or modify the the .adoc source file, and raise a pull request.

Naming Conventions

For documents with inclusions, use '_' to separate out the logical hierarchy:

xxx-xxx/xxx-xxx.adoc
        _xxx-xxx_ppp-ppp.adoc
        _xxx-xxx_qqq-qqq.adoc
        _xxx-xxx_qqq-qqq_mmm-mmm.adoc
        _xxx-xxx_qqq-qqq_nnn-nnn.adoc

Any referenced images should be in subdirectories of the images directory:

xxx-xxx/images/.
              /ppp-ppp/.
              /qqq-qqq/.
                      /mmm-mmm
                      /nnn-nnn

And similarly any resources should be in the resources subdirectory:

xxx-xxx/resources/.
                  ppp-ppp/.
                  qqq-qqq/.
                         /mmm-mmm/
                         /nnn-nnn/

Build and Review (using Maven)

To (re)build the documentation locally prior to release, use:

sh preview-html.sh

The site will be generated at target/site/index.html, and then uses Python to start a webserver and a browser pointing at the site.

Publish procedure

Only Apache Isis committers can publish to isis.apache.org. See the committers' guide for details.