archdoc/archdoc-ui

Web UI used to visualize and explore ArchDoc models.

archdoc-ui's Issues

[SPEC] Change "services" to "components", to be more C4-like

Currently, the ArchDoc spec outlines two major contracts: users and services. The 'service' construct refers to microservices or apps that exist within your architecture. However, I feel we want to rename the term "service" to "component" to be more general. Components can be APIs, databases, storage buckets, etc. Another advantage of components is that it adheres to the C4 architecture framework terminology.

Examples

Instead of the following ArchDoc spec:

services:
  api:
    description: The API gateway of the application.
    repository: https://github.com/MyOrg/api-gateway
    tags:
      - backend
      - public

We will be using the following:

components:
  api:
    description: The API gateway of the application.
    repository: https://github.com/MyOrg/api-gateway
    tags:
      - backend
      - public

Acceptance Criteria

• ArchDoc UI parses ArchDoc spec files so that the services is renamed to components
• All ArchDoc UI tests are modified to reflect this
• All ArchDoc spec examples are updated to the latest schema

[BUG] Node labels are miss-aligned to center

As a user, I want to ensure that the labels below each node are properly centered.

Steps to Reproduce

1. Run archdoc examples/blog.yaml
2. Zoom in on one of the nodes.

Expected

The label below the node should be centered.

Actual

[FEAT] Auto focus/center on node when clicked

[FEAT] Make ArchDoc UI side panel resizable

[BUG] Edge arrows do not end at the start of the node shape

As a user, I want to ensure that the edges are properly visible.

Steps to Reproduce

1. Run archdoc examples/blog.yaml
2. Move a node around another node that are connected.

Expected

The edge is rendered such that the arrow is fully visible, and there is no white space between the edge and the outline of a node.

Actual

[CICD] Create NPM package pipeline

As a developer, I want to automatically build, test, and publish new changes to archdoc-ui to NPM.

Acceptance Criteria

1. Every PR into the main branch will kick off the CI/CD process to build, test, and publish to NPM.
2. At least one unit test runs apart of the CI/CD process.
3. Before publishing to NPM, the version is bumped and committed to source.
4. A test PR to main is merged to test and validate that the ArchDoc ui package can be successfully updated.