Merge pull request #17 from ArchDoc/feature/2-replace-services-with-components

#2 - Renamed 'services' to 'components'

Author: mtfuller

README.md

@@ -5,13 +5,13 @@ ArchDoc UI allows users to define and visualize software systems. With ArchDoc U
 
 ## Why ArchDoc?
 
-ArchDoc UI is designed to tackle the problem of miscommunication between developers, architects, and other stakeholders in software development projects. With ArchDoc, you can define and visualize software models, which helps the whole team to know the services, components, and clients of your organization's software system..
+ArchDoc UI is designed to tackle the problem of miscommunication between developers, architects, and other stakeholders in software development projects. With ArchDoc, you can define and visualize software models, which helps the whole team to know the components, components, and clients of your organization's software system..
 
 ## Features
 
  - **Intuitive Diagrams**: ArchDoc UI arranges your organization's architecture in a clear, easy-to-understand graph. Powered by [React Flow](https://reactflow.dev/).
  - **Easy-to-use**: No need to learn a new diagram-as-code DSL, simply create a YAML file and use the `archdoc` cli tool to visualize it.
- - **Embedded Documentation**: Define and read documentation for your services, while exploring your architecture.
+ - **Embedded Documentation**: Define and read documentation for your components, while exploring your architecture.
  - **Open-source**: By the people, for the people.
 
 ## Getting Started

examples/blog.yaml

@@ -12,7 +12,7 @@ users:
  ui: "Posts blog articles"
  documentation: "The admin user that posts articles."
 
-services:
+components:
  ui:
  description: "The frontend application that serves the application users"
  repository: "https://github.com/example/myblogui"

examples/mealplanner.yaml

@@ -12,7 +12,7 @@ users:
  other-service: "Asks the other service for stuff"
  documentation: "The user of the application"
 
-services:
+components:
  ui:
  description: "I CHANGED THIS!!!"
  repository: "https://github.com/ArchDoc/archdoc-ui"
@@ -32,7 +32,7 @@ services:
  documentation: "Documentation for the other service."
 
  api:
- description: "The API gateway of the application. This services provides a REST API to consumers."
+ description: "The API gateway of the application. This components provides a REST API to consumers."
  repository: "https://github.com/ArchDoc/archdoc-ui"
  tags:
  - "my"
@@ -41,7 +41,7 @@ services:
  auth-service: "Generates admin JWTs"
  recipe-service: "Manages users recipes"
  product-service: "Searches grocery store product catalogs"
- documentation: "The API gateway of the application. This services provides a REST API to consumers."
+ documentation: "The API gateway of the application. This components provides a REST API to consumers."
 
  auth-service:
  description: "A microservice with the purpose of authenticating and authorizing users. This service signs and returns properly signed JWTs to be reused by clients to access other resources"

examples/ridesharing.yaml

@@ -13,7 +13,7 @@ users:
  mobile-app: "B"
  driver-ui: "B"
 
-services:
+components:
  mobile-app:
  description: "2"
  dependencies:

ui/public/simple-arch.yaml

@@ -12,7 +12,7 @@ users:
  other-service: "Asks the other service for stuff"
  documentation: "The user of the application"
 
-services:
+components:
  ui:
  description: "The user of the application"
  repository: "https://github.com/ArchDoc/archdoc-ui"
@@ -32,7 +32,7 @@ services:
  documentation: "Documentation for the other service."
 
  api:
- description: "The API gateway of the application. This services provides a REST API to consumers."
+ description: "The API gateway of the application. This components provides a REST API to consumers."
  repository: "https://github.com/ArchDoc/archdoc-ui"
  tags:
  - "my"
@@ -41,7 +41,7 @@ services:
  auth-service: "Generates admin JWTs"
  recipe-service: "Manages users recipes"
  product-service: "Searches grocery store product catalogs"
- documentation: "The API gateway of the application. This services provides a REST API to consumers."
+ documentation: "The API gateway of the application. This components provides a REST API to consumers."
 
  auth-service:
  description: "A microservice with the purpose of authenticating and authorizing users. This service signs and returns properly signed JWTs to be reused by clients to access other resources"

ui/src/examples/simple-arch.json

@@ -25,7 +25,7 @@
  },
  {
  "name": "api",
- "description": "The API gateway of the application. This services provides a REST API to consumers.",
+ "description": "The API gateway of the application. This components provides a REST API to consumers.",
  "tags": ["my", "api"],
  "repository": "https://github.com/ArchDoc/archdoc-ui",
  "consumers": [
@@ -36,7 +36,7 @@
  { "sourceId": "api", "targetId": "recipe-service", "description": "Manages users recipes" },
  { "sourceId": "api", "targetId": "product-service", "description": "Searches grocery store product catalogs" }
  ],
- "documentation": "The API gateway of the application. This services provides a REST API to consumers."
+ "documentation": "The API gateway of the application. This components provides a REST API to consumers."
  },
  {
  "name": "auth-service",

ui/src/examples/simple-arch.new.json

@@ -43,7 +43,7 @@
  {
  "name": "api",
  "type": "service",
- "description": "The API gateway of the application. This services provides a REST API to consumers.",
+ "description": "The API gateway of the application. This components provides a REST API to consumers.",
  "tags": ["my", "api"],
  "repository": "https://github.com/ArchDoc/archdoc-ui",
  "consumers": [
@@ -55,7 +55,7 @@
  { "componentId": "product-service", "description": "Searches grocery store product catalogs" },
  { "componentId": "widget-service", "description": "Searches grocery store product catalogs" }
  ],
- "documentation": "The API gateway of the application. This services provides a REST API to consumers."
+ "documentation": "The API gateway of the application. This components provides a REST API to consumers."
  },
  {
  "name": "auth-service",

ui/src/examples/simple-arch.yaml

@@ -11,7 +11,7 @@ users:
  other-service: "Asks the other service for stuff"
  documentation: "The user of the application"
 
-services:
+components:
  ui:
  description: "The user of the application"
  repository: "https://github.com/ArchDoc/archdoc-ui"
@@ -31,7 +31,7 @@ services:
  documentation: "Documentation for the other service."
 
  api:
- description: "The API gateway of the application. This services provides a REST API to consumers."
+ description: "The API gateway of the application. This components provides a REST API to consumers."
  repository: "https://github.com/ArchDoc/archdoc-ui"
  tags:
  - "my"
@@ -40,7 +40,7 @@ services:
  auth-service: "Generates admin JWTs"
  recipe-service: "Manages users recipes"
  product-service: "Searches grocery store product catalogs"
- documentation: "The API gateway of the application. This services provides a REST API to consumers."
+ documentation: "The API gateway of the application. This components provides a REST API to consumers."
 
  auth-service:
  description: "A microservice with the purpose of authenticating and authorizing users. This service signs and returns properly signed JWTs to be reused by clients to access other resources"

ui/src/examples/simpleArch.ts

@@ -12,7 +12,7 @@ users:
  other-service: "Asks the other service for stuff"
  documentation: "The user of the application"
 
-services:
+components:
  ui:
  description: "The user of the application"
  repository: "https://github.com/ArchDoc/archdoc-ui"
@@ -30,7 +30,7 @@ services:
  - "other"
  documentation: "Documentation for the other service."
  api:
- description: "The API gateway of the application. This services provides a REST API to consumers."
+ description: "The API gateway of the application. This components provides a REST API to consumers."
  repository: "https://github.com/ArchDoc/archdoc-ui"
  tags:
  - "my"
@@ -39,7 +39,7 @@ services:
  auth-service: "Generates admin JWTs"
  recipe-service: "Manages users recipes"
  product-service: "Searches grocery store product catalogs"
- documentation: "The API gateway of the application. This services provides a REST API to consumers."
+ documentation: "The API gateway of the application. This components provides a REST API to consumers."
  auth-service:
  description: "A microservice with the purpose of authenticating and authorizing users. This service signs and returns properly signed JWTs to be reused by clients to access other resources"
  tags:

ui/src/models/ArchdocSpec.tsx

@@ -12,7 +12,7 @@ export interface ArchdocComponentSpec {
 export interface ArchdocSpec {
  archdoc: string
  users: Record<string, ArchdocComponentSpec>
- services: Record<string, ArchdocComponentSpec>
+ components: Record<string, ArchdocComponentSpec>
 }
 
 export const ArchdocSpecSchema: JSONSchemaType<ArchdocSpec> = {
@@ -50,7 +50,7 @@ export const ArchdocSpecSchema: JSONSchemaType<ArchdocSpec> = {
  required: [],
  additionalProperties: false
  },
- services: {
+ components: {
  type: "object",
  patternProperties: {
  "^.*$": {
@@ -82,6 +82,6 @@ export const ArchdocSpecSchema: JSONSchemaType<ArchdocSpec> = {
  additionalProperties: false
  },
  },
- required: ["archdoc", "users", "services"],
+ required: ["archdoc", "users", "components"],
  additionalProperties: false,
 }