From aaf94d398114f13b2f5ac529b426101494bd4b98 Mon Sep 17 00:00:00 2001 From: Tom Page Date: Thu, 9 Nov 2017 10:45:43 +0000 Subject: [PATCH] RM-5806 Add links to the technical documentation. --- README.txt | 9 ++++++++- rm-community/documentation/index.md | 4 ++++ 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 rm-community/documentation/index.md diff --git a/README.txt b/README.txt index 9d1bfe30c3..bc41080f3b 100644 --- a/README.txt +++ b/README.txt @@ -32,6 +32,13 @@ Configuring a different DB other than H2 (e.g. MySQL or PostgreSQL): mvn clean install -Pstart-repo,use-mysql +Technical documentation: +------------------------ + +Technical documentation is available at rm-community/documentation/index.md and rm-enterprise/documentation/index.md. +This should be particularly useful for anyone wanting to integrate with or extend RM. + + Running integration test: ------------------------- @@ -145,4 +152,4 @@ Currently it's 1.0.0 (alfresco-search-services-1.0.0.zip) Unzip it and change to the "solr" folder within it. Start the Solr server using the following command: solr start -a "-Dcreate.alfresco.defaults=alfresco,archive" -Start your repository \ No newline at end of file +Start your repository diff --git a/rm-community/documentation/index.md b/rm-community/documentation/index.md new file mode 100644 index 0000000000..325117825f --- /dev/null +++ b/rm-community/documentation/index.md @@ -0,0 +1,4 @@ +## Community Technical Documentation Index + +* [Enterprise Technical Documentation](../../rm-enterprise/documentation/index.md) (the link will only work if this repository contains the enterprise code) +* [Overview of the design of RM](overview.md)