You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/03/21 12:48:16 UTC
[isis] 07/10: ISIS-2062: reorg of core-concepts
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 00ecd1b830b78fa3df310ecb100116de22a1e6c1
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sat Mar 21 09:16:19 2020 +0000
ISIS-2062: reorg of core-concepts
---
antora/supplemental-ui/css/site-custom.css | 4 ++++
api/adoc/userguide/modules/fun/pages/core-concepts.adoc | 9 ++++++---
.../apache-isis-vs-cqrs-and-event-sourcing.adoc | 4 ++--
.../modules/fun/pages/core-concepts/architecture.adoc | 1 -
.../pages/core-concepts/{philosophy.adoc => core-values.adoc} | 10 ++++------
.../{philosophy => core-values}/aligned-with-the-business.adoc | 0
.../easing-the-road-to-ddd.adoc} | 7 +++----
.../core-concepts/{philosophy => }/domain-driven-design.adoc | 0
.../core-concepts/{philosophy => }/naked-objects-pattern.adoc | 0
9 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/antora/supplemental-ui/css/site-custom.css b/antora/supplemental-ui/css/site-custom.css
index b7e4744..640de42 100644
--- a/antora/supplemental-ui/css/site-custom.css
+++ b/antora/supplemental-ui/css/site-custom.css
@@ -7,6 +7,10 @@
font-weight: 500;
}
+.doc h4:not(.discrete) {
+ font-style: italic;
+}
+
.doc .sidebarblock.float-left {
min-width: 400px;
margin-right: 30px;
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts.adoc
index e0c44e0..8fedc4f 100644
--- a/api/adoc/userguide/modules/fun/pages/core-concepts.adoc
+++ b/api/adoc/userguide/modules/fun/pages/core-concepts.adoc
@@ -3,10 +3,13 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:page-partial:
-This introductory chapter should give you a good about what Apache Isis actually *is*: the ideas and principles that it builds upon, how it compares with other frameworks, what the building blocks are for actually writing an Apache Isis application, and what services and features the framework provides for you to leverage in your own apps.
+This introductory chapter should give you a good about what Apache Isis actually *is*: the ideas and principles that it builds upon, what its core values are, its architecture, how it compares to other architectural approaches other frameworks, and how it can be deployed.
-include::core-concepts/philosophy.adoc[leveloffset=+1]
+include::core-concepts/domain-driven-design.adoc[leveloffset=+1]
+include::core-concepts/naked-objects-pattern.adoc[leveloffset=+1]
+include::core-concepts/core-values.adoc[leveloffset=+1]
include::core-concepts/architecture.adoc[leveloffset=+1]
-include::core-concepts/deployment-options.adoc[leveloffset=+1]
include::core-concepts/metamodel.adoc[leveloffset=+1]
+include::core-concepts/apache-isis-vs-cqrs-and-event-sourcing.adoc[leveloffset=+1]
+include::core-concepts/deployment-options.adoc[leveloffset=+1]
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/architecture/apache-isis-vs-cqrs-and-event-sourcing.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/apache-isis-vs-cqrs-and-event-sourcing.adoc
similarity index 98%
rename from api/adoc/userguide/modules/fun/pages/core-concepts/architecture/apache-isis-vs-cqrs-and-event-sourcing.adoc
rename to api/adoc/userguide/modules/fun/pages/core-concepts/apache-isis-vs-cqrs-and-event-sourcing.adoc
index 6b373ff..67c1fdf 100644
--- a/api/adoc/userguide/modules/fun/pages/core-concepts/architecture/apache-isis-vs-cqrs-and-event-sourcing.adoc
+++ b/api/adoc/userguide/modules/fun/pages/core-concepts/apache-isis-vs-cqrs-and-event-sourcing.adoc
@@ -1,9 +1,9 @@
-= Apache Isis vs CQRS & Event Sourcing
+= Apache Isis vs CQRS/ES
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:page-partial:
-CQRS and Event Sourcing are two architectural patterns often used (and often used together) to implement domain driven design systems.
+CQRS and Event Sourcing (ES) are two architectural patterns often used (and often used together) to implement domain driven design systems.
This section explores the similarities and differences that Apache Isis has with these other architectural approaches.
== CQRS
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/architecture.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/architecture.adoc
index 53ca4d9..8f22618 100644
--- a/api/adoc/userguide/modules/fun/pages/core-concepts/architecture.adoc
+++ b/api/adoc/userguide/modules/fun/pages/core-concepts/architecture.adoc
@@ -7,4 +7,3 @@ This section describes some of the architectural patterns upon which Apache Isis
include::architecture/hexagonal-architecture.adoc[leveloffset=+1]
include::architecture/aop.adoc[leveloffset=+1]
-include::architecture/apache-isis-vs-cqrs-and-event-sourcing.adoc[leveloffset=+1]
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/core-values.adoc
similarity index 69%
rename from api/adoc/userguide/modules/fun/pages/core-concepts/philosophy.adoc
rename to api/adoc/userguide/modules/fun/pages/core-concepts/core-values.adoc
index 4043b87..1a9ebf6 100644
--- a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy.adoc
+++ b/api/adoc/userguide/modules/fun/pages/core-concepts/core-values.adoc
@@ -1,11 +1,9 @@
-= Philosophy
+= Core Values
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:page-partial:
-This section describes the philosophy upon which the Apache Isis framework is based.
+//This section describes the values upon which the Apache Isis framework is based.
-include::philosophy/domain-driven-design.adoc[leveloffset=+1]
-include::philosophy/naked-objects-pattern.adoc[leveloffset=+1]
-include::philosophy/how-eases-ddd.adoc[leveloffset=+1]
-include::philosophy/aligned-with-the-business.adoc[leveloffset=+1]
+include::core-values/aligned-with-the-business.adoc[leveloffset=+1]
+include::core-values/easing-the-road-to-ddd.adoc[leveloffset=+1]
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/aligned-with-the-business.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/core-values/aligned-with-the-business.adoc
similarity index 100%
rename from api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/aligned-with-the-business.adoc
rename to api/adoc/userguide/modules/fun/pages/core-concepts/core-values/aligned-with-the-business.adoc
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/how-eases-ddd.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/core-values/easing-the-road-to-ddd.adoc
similarity index 96%
rename from api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/how-eases-ddd.adoc
rename to api/adoc/userguide/modules/fun/pages/core-concepts/core-values/easing-the-road-to-ddd.adoc
index 0db2687..bb8f821 100644
--- a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/how-eases-ddd.adoc
+++ b/api/adoc/userguide/modules/fun/pages/core-concepts/core-values/easing-the-road-to-ddd.adoc
@@ -1,12 +1,11 @@
-[[how-eases-ddd]]
-= How Apache Isis eases DDD
+= Easing the road to DDD
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:page-partial:
-The case for _DDD_ might be compelling, but that doesn't necessarily make it easy to do.
+The case for xref:core-concepts.adoc#domain-driven-design[domain driven design] might be compelling, but that doesn't necessarily make it easy to do.
Let's take a look at some of the challenges that _DDD_ throws up and see how Apache Isis (and its implementation of the naked objects pattern) helps address them.
== DDD takes a conscious effort
@@ -94,5 +93,5 @@ We can start working solely on our domain, even if we suspect it will be simple.
If it is indeed a simple domain, then there's no hardship, but if unexpected subtleties arise, then we're in a good position to handle them.
If you're just starting out writing domain-driven applications, then Apache Isis should significantly ease your journey into applying _DDD_.
-On the other hand, if you've used _DDD_ for a while, then you should find Isis a very useful new tool in your arsenal.
+And if you _have_ used _DDD_ for a while, then you should find the framework a very useful new tool in your arsenal.
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/domain-driven-design.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/domain-driven-design.adoc
similarity index 100%
rename from api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/domain-driven-design.adoc
rename to api/adoc/userguide/modules/fun/pages/core-concepts/domain-driven-design.adoc
diff --git a/api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/naked-objects-pattern.adoc b/api/adoc/userguide/modules/fun/pages/core-concepts/naked-objects-pattern.adoc
similarity index 100%
rename from api/adoc/userguide/modules/fun/pages/core-concepts/philosophy/naked-objects-pattern.adoc
rename to api/adoc/userguide/modules/fun/pages/core-concepts/naked-objects-pattern.adoc