Merge pull request #156 from redhat-appstudio/rename

Rename the book to "architecture"

ADR/0002-feature-flags.md

@@ -124,11 +124,11 @@ can know that the [integration-service] features of HACBS are enabled in the wor
 
 Originally drafted in a [google document](https://docs.google.com/document/d/1KcXWZ8VGUg_iR0RjdGuDYedP8ZW63XCgF26KZUNgpeQ/edit)
 
-[hac]: ../book/hybrid-application-console.md
+[hac]: ../architecture/hybrid-application-console.md
 [hac-dev]: https://github.com/openshift/hac-dev
-[has]: ../book/application-service.md
-[build-service]: ../book/build-service.md
-[integration-service]: ../book/integration-service.md
+[has]: ../architecture/application-service.md
+[build-service]: ../architecture/build-service.md
+[integration-service]: ../architecture/integration-service.md
 [customized pipelines]: https://issues.redhat.com/browse/HACBS-9
 [KCP]: ../ref/kcp.md
 [APIBinding]: ../ref/kcp.md#apibinding

ADR/0003-interacting-with-internal-services.md

@@ -80,5 +80,5 @@ A proof of concept for the **Internal Services Controller** can be found [here](
 ---
 
 [KCP]: ../ref/kcp.md
-[release-service]: ../book/release-service.md
+[release-service]: ../architecture/release-service.md
 

ADR/0014-let-pipelines-proceed.md

@@ -52,4 +52,4 @@ for users ([STONE-459]).
 [STONE-459]: https://issues.redhat.com/browse/STONE-459
 [Environments]: ../ref/application-environment-api.html#environment
 [ADR-0030]: 0030-tekton-results-naming-convention.html
-[enterprise contract]: ../book/enterprise-contract.html
+[enterprise contract]: ../architecture/enterprise-contract.html

ADR/0016-integration-service-promotion-logic.md

@@ -89,6 +89,6 @@ The promotion logic has originally been implemented as part of HACBS-802 / HACBS
 This document is created for posterity and visibility.
 
 [parentEnvironment]: https://github.com/redhat-appstudio/application-api/blob/5f554103549049bf02c1e344a13f0711081df6a1/api/v1alpha1/environment_types.go#L36-L39
-[Global Candidate List]: ../book/integration-service.html
+[Global Candidate List]: ../architecture/integration-service.html
 [HACBS-802]: https://issues.redhat.com/browse/HACBS-802
 [HACBS-801]: https://issues.redhat.com/browse/HACBS-801

ADR/0021-partner-tasks.md

@@ -59,7 +59,7 @@ A non-exhaustive list of checks that would be run on a Task is:
 ## Out-of-scope
 
 * Supporting validation of Tasks inside Stonesoup before submission would be out-of-scope. However, partners should be able to import a
-Component into StoneSoup, customize their Pipeline definition in the .tekton directory and have the changes validated in a PipelineRun execution in StoneSoup. To be able to be productive with this flow, they'd need to be able to do https://github.com/redhat-appstudio/book/pull/64 .
+Component into StoneSoup, customize their Pipeline definition in the .tekton directory and have the changes validated in a PipelineRun execution in StoneSoup. To be able to be productive with this flow, they'd need to be able to do https://github.com/redhat-appstudio/architecture/pull/64 .
 
 ## Alternatives
 

ADR/0023-git-references-to-furnish-integration-test-scenarios.md

@@ -75,7 +75,7 @@ enabling customers to test functionality and provide feedback during the develop
 use of bundle resolvers, if needed.
 
 
-[CR]: https://redhat-appstudio.github.io/book/ref/integration-service.html#integrationtestscenariospec
+[CR]: https://redhat-appstudio.github.io/architecture/ref/integration-service.html#integrationtestscenariospec
 [RHTAP-402]: https://issues.redhat.com/browse/RHTAP-402
 [PLNSRVCE-1030]: https://issues.redhat.com/browse/PLNSRVCE-1030
 [Tekton-resolvers]: https://tekton.dev/vault/pipelines-main/resolution/

ADR/0029-component-dependencies.md

@@ -94,7 +94,7 @@ The [build-service] will also update the PR it filed (PR#2) when it detects new
 * When [build-service] responds to the completion of a build of a PR (PR #1), it propagates the digest of the image built from that PR to the git repository of another Component as another PR (PR#2). It follows the declared `build-nudges-ref` references to know which other repos should receive an update PR. It marks the PR that it submits (PR #2) as being in the same PR Group (`@`-prefixed name of the git source branch) as the triggering PR (PR #1). This enables pre-merge testing of both changes.
 * When [build-service] submits PR #2:
   * It marks it as "Draft" and it includes a reference to the triggering PR (PR #1) in the description of the automatically submitted PR (PR #2), giving the user some indication that it should not be merged out of order.
-  * It checks to see if the two Components (source and destination as determined by the `build-nudges-ref` references) are in the same git repository (a monorepo) and to see if PR #1 contains any changes to files that would match the `pipelinesascode.tekton.dev/on-cel-expression` on the destination Component. If it does, then when creating PR #2, it create a new commit copying the changes from the matching files in PR #1 and it bases the commit that updates the digest reference on top of this synthetic commit. This is meant to address [Adam's monorepo scenario](https://github.com/redhat-appstudio/book/pull/113#discussion_r1283714201).
+  * It checks to see if the two Components (source and destination as determined by the `build-nudges-ref` references) are in the same git repository (a monorepo) and to see if PR #1 contains any changes to files that would match the `pipelinesascode.tekton.dev/on-cel-expression` on the destination Component. If it does, then when creating PR #2, it create a new commit copying the changes from the matching files in PR #1 and it bases the commit that updates the digest reference on top of this synthetic commit. This is meant to address [Adam's monorepo scenario](https://github.com/redhat-appstudio/architecture/pull/113#discussion_r1283714201).
 
 ## Applied to Use Cases
 

README.md

@@ -1,4 +1,4 @@
-# Book of AppStudio
+# Architecture of AppStudio
 
 This repository contains the technical and architecture documents for AppStudio.
 User documentation is out of scope.
@@ -7,7 +7,7 @@ User documentation is out of scope.
 
 ### The Technical Overview Document
 
-[/book](./book/index.md) folder hosts the technical overview document. This document represents the latest state of agreed technical and architectural decisions. See [contributing](#contributing) on how to propose changes.
+[/architecture](./architecture/index.md) folder hosts the technical overview document. This document represents the latest state of agreed technical and architectural decisions. See [contributing](#contributing) on how to propose changes.
 
 [/ref](./ref/index.md) folder hosts the API references for all the related services. These API references are generated during publish flow.
 

_config.yml

@@ -1,28 +1,28 @@
 remote_theme: vaibhavvikas/jekyll-theme-minimalistic
-title: Book Of AppStudio
+title: Architecture Of AppStudio
 description: Technical documents about the Managed Developer Platform
 color-scheme: auto
 navigation:
   - name: Technical Overview Document
-    link: /book/book/index.html
+    link: /architecture/architecture/index.html
   - name: Architecture Decision Records
-    link: /book/ADR/index.html
+    link: /architecture/ADR/index.html
   - name: API References
-    link: /book/ref/index.html
+    link: /architecture/ref/index.html
     sublist:
     - name: Application and Environment API
-      link: /book/ref/application-environment-api.html
+      link: /architecture/ref/application-environment-api.html
     - name: Service Provider (SPI)
-      link: /book/ref/service-provider.html
+      link: /architecture/ref/service-provider.html
     - name: GitOps Service
-      link: /book/ref/gitops.html
+      link: /architecture/ref/gitops.html
     - name: Build Service
-      link: /book/ref/build-service.html
+      link: /architecture/ref/build-service.html
     - name: JVM Build Service
-      link: /book/ref/jvm-build-service.html
+      link: /architecture/ref/jvm-build-service.html
     - name: Integration Service
-      link: /book/ref/integration-service.html
+      link: /architecture/ref/integration-service.html
     - name: Release Service
-      link: /book/ref/release-service.html
+      link: /architecture/ref/release-service.html
     - name: Enterprise Contract
-      link: /book/ref/enterprise-contract.html
+      link: /architecture/ref/enterprise-contract.html

book/HAS/hybrid-application-service-api.md → architecture/HAS/hybrid-application-service-api.md

@@ -2,11 +2,11 @@
 
 ## Overview
 
-The official Hybrid Application Service (HAS) APIs are listed in the AppStudio [API Reference](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#application).  The APIs Specific to HAS are:
+The official Hybrid Application Service (HAS) APIs are listed in the AppStudio [API Reference](https://redhat-appstudio.github.io/architecture/ref/application-environment-api.html#application).  The APIs Specific to HAS are:
 
-* [Application](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#application)
-* [Component](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#component)
-* [ComponentDetectionQuery](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#componentdetectionquery)
+* [Application](https://redhat-appstudio.github.io/architecture/ref/application-environment-api.html#application)
+* [Component](https://redhat-appstudio.github.io/architecture/ref/application-environment-api.html#component)
+* [ComponentDetectionQuery](https://redhat-appstudio.github.io/architecture/ref/application-environment-api.html#componentdetectionquery)
 
 The topics below offer a more detailed explanation of the API usage with examples.
 

book/build-service.md → architecture/build-service.md

@@ -56,7 +56,7 @@ Custom Mode:
 
 #### PipelineRun selection
 
-The Build Service owns [BuildPipelineSelector CRD](https://redhat-appstudio.github.io/book/ref/build-service.html#buildpipelineselector) which defines which PipelineRun to select for the Component CR. By default global BuildPipelineSelector `build-pipeline-selector` in `build-service` namespace is used. BuildPipelineSelector CR contains selectors, the first matching selector is used for the Component CR. The list of selectors can be extended by creating BuildPipelineSelector CR with the same name as the Application CR in the user's namespace. This will ensure that it is applied to Component CRs under the corresponding Application CR. The list of selectors can be also extended for the whole user namespace by creating BuildPipelineSelector CR named `build-pipeline-selector` in the user's namespace.
+The Build Service owns [BuildPipelineSelector CRD](https://redhat-appstudio.github.io/architecture/ref/build-service.html#buildpipelineselector) which defines which PipelineRun to select for the Component CR. By default global BuildPipelineSelector `build-pipeline-selector` in `build-service` namespace is used. BuildPipelineSelector CR contains selectors, the first matching selector is used for the Component CR. The list of selectors can be extended by creating BuildPipelineSelector CR with the same name as the Application CR in the user's namespace. This will ensure that it is applied to Component CRs under the corresponding Application CR. The list of selectors can be also extended for the whole user namespace by creating BuildPipelineSelector CR named `build-pipeline-selector` in the user's namespace.
 
 Selectors are processed in this order:
 - BuildPipelineSelector CR with the same name as Application CR in the user's namespace

book/enterprise-contract.md → architecture/enterprise-contract.md

@@ -80,7 +80,7 @@ You can view the source code for the ECP CRD
 [here](https://github.com/enterprise-contract/enterprise-contract-controller) and
 see its documentation [here](https://enterprise-contract.github.io/ecc/main/).
 See also the related
-[API Reference](https://redhat-appstudio.github.io/book/ref/enterprise-contract.html)
+[API Reference](https://redhat-appstudio.github.io/architecture/ref/enterprise-contract.html)
 
 ### EC Policies
 
@@ -133,7 +133,7 @@ Additional Resources
 
 - [AppStudio Documentation](https://redhat-appstudio.github.io/docs.appstudio.io)
 - [Enterprise Contract Documentation](https://enterprise-contract.github.io/)
-- [Book of AppStudio](https://redhat-appstudio.github.io/book/)
+- [Architecture of AppStudio](https://redhat-appstudio.github.io/architecture/)
 
 
 

book/image-controller.md → architecture/image-controller.md

@@ -3,7 +3,7 @@
 # Overview
 Image controller sets up and manages container image repositories for an application's components. This enables greater component isolation within AppStudio where each component has its own image repository and secret for pushing images built via AppStudio.
 
-The image controller can perform three actions on image repositories by watching for either specific annotation changes or deletion events of a [Component CR](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#component):
+The image controller can perform three actions on image repositories by watching for either specific annotation changes or deletion events of a [Component CR](https://redhat-appstudio.github.io/architecture/ref/application-environment-api.html#component):
 
 - **Setup image repository**: Image controller creates an image repository for the Component CR in a remote image registry as well as a robot account which is specific to that repository for image push. A Kubernetes Secret object is also created with that robot account token in order to make it available for build PipelineRun.