Skip to content

Commit

Permalink
SDK: renaming docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ivangsa committed Jan 31, 2023
1 parent f157433 commit 6165e0c
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .asyncapi-tool
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ZenWave Code Generator
title: ZenWave SDK
description: DDD and API-First for Event-Driven Microservices
links:
websiteUrl: https://zenwave360.github.io/
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing to ZenWave Code Generator
ZenWave Code Generator features two complementary contributing models:
# Contributing to ZenWave SDK
ZenWave SDK features two complementary contributing models:

- Plugins as a Bazaar
- Core as a Cathedral

## Plugins as a Bazaar

One of the main promises of ZenWave Code Generator is to provide a plugin system that allows developers to easily extend and personalize the core functionality of the tool, create entirely new plugins or [fork existing ones](https://github.com/ZenWave360/zenwave-sdk#forking-an-standard-or-custom-plugin).
One of the main promises of ZenWave SDK is to provide a plugin system that allows developers to easily extend and personalize the core functionality of the tool, create entirely new plugins or [fork existing ones](https://github.com/ZenWave360/zenwave-sdk#forking-an-standard-or-custom-plugin).

Plugins as packed as standard java jar files and installed on any local, corporate or public maven repo and can be added to jbang or maven classpath as a dependency.

Expand All @@ -24,7 +24,7 @@ Keep in mind that standard original plugins are designed to be simple, middle of

## Core as a Cathedral

Creating and maintaining the core of ZenWave Code Generator requires time and commitment. If you are inclined to become a core developer consider the following steps as a natural progression:
Creating and maintaining the core of ZenWave SDK requires time and commitment. If you are inclined to become a core developer consider the following steps as a natural progression:

- Become a zenwave user your self. Use the tool to generate code for your projects and learn how it works.
- Report any issues you find. If you are not sure if it is a bug or a feature request, open an issue, and we will discuss it.
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ZenWave Code Generator
# ZenWave SDK

<p align="center" markdown="1">
<img src="docs/logos/code-generator-logo-dark.svg#gh-dark-mode-only" alt="ZW> Code Generator" />
Expand All @@ -15,26 +15,26 @@
[![branches coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/badges/branches.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)

ZenWave Code Generator is a configurable and extensible code generator tool for **Domain Driven Design (DDD)** and **API-First** that can generate code from a mix of different models including:
ZenWave SDK is a configurable and extensible code generator tool for **Domain Driven Design (DDD)** and **API-First** that can generate code from a mix of different models including:

- JHipster Domain Language (JDL)
- AsyncAPI
- OpenAPI

**Table of Contents:**

- [ZenWave Code Generator](#zenwave-sdk)
- [ZenWave SDK](#zenwave-sdk)
- [Jbang Instalation](#jbang-instalation)
- [Features / Roadmap](#features--roadmap)
- [Building from source](#building-from-source)
- [Usage](#usage)
- [Available Plugins](#available-plugins)
- [Forking an Standard or Custom Plugin](#forking-an-standard-or-custom-plugin)
- [ZenWave Code Generator Documentation](#zenwave-sdk-documentation)
- [ZenWave SDK Documentation](#zenwave-sdk-documentation)

## Jbang Instalation

The easiest way to install ZenWave Code Generator is as a [JBang alias](https://www.jbang.dev/documentation/guide/latest/alias_catalogs.html):
The easiest way to install ZenWave SDK is as a [JBang alias](https://www.jbang.dev/documentation/guide/latest/alias_catalogs.html):

```shell
jbang alias add --fresh --name=zw release@zenwave360/zenwave-sdk
Expand Down Expand Up @@ -71,11 +71,11 @@ JBang will use you maven settings for repository resolution, but you can also sp

## Features / Roadmap

- [x] ZenWave Code Generator CLI
- [x] ZenWave SDK CLI
- [x] Default parsers, processors, plugins, templating, formatters, writers, etc... for AsyncAPI, OpenAPI and JDL.
- [x] Help command: detailed, json, markdown, list of available plugins
- [x] Fork existing (custom or standard) plugin command
- [x] ZenWave Code Generator Maven Plugin
- [x] ZenWave SDK Maven Plugin
- [x] Standard Plugins
- [x] JDL Backend Application (flexible hexagonal architecture)
- [x] Domain Entities
Expand Down Expand Up @@ -191,7 +191,7 @@ Refer to individual plugin's documentation for more information:

## Forking an Standard or Custom Plugin

One promise of ZenWave Code Generator is to be easily extensible and adaptable to your project or your organization needs and likes.
One promise of ZenWave SDK is to be easily extensible and adaptable to your project or your organization needs and likes.

You can always fork an existing plugin with the following command:

Expand Down Expand Up @@ -219,6 +219,6 @@ mvn clean install

Now you can add this jar to the list of available plugins in [jbang install command](#jbang-instalation)

# ZenWave Code Generator Documentation
# ZenWave SDK Documentation

Please refer to the [documentation](https://zenwave360.github.io/zenwave-sdk/) website for more information.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Site settings
title: ZenWave Code Generator
title: ZenWave SDK
description: DDD and API-First Modeling Tools
github_username: ivangsa
# Theme settings
Expand Down
18 changes: 9 additions & 9 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ZenWave Code Generator
# ZenWave SDK

> 👉 ZenWave360 Helps You Create Software that's Easy to Understand
Expand All @@ -12,7 +12,7 @@

## Domain Driven Design (DDD) and API-First for Event Driven Microservices

ZenWave Code Generator is a configurable and extensible code generator tool for **Domain Driven Design (DDD)** and **API-First** for **Event Driven Microservices** that can generate code from a mix of different models including:
ZenWave SDK is a configurable and extensible code generator tool for **Domain Driven Design (DDD)** and **API-First** for **Event Driven Microservices** that can generate code from a mix of different models including:

- [JHipster Domain Language (JDL)](https://www.jhipster.tech/jdl/intro)
- [AsyncAPI](https://www.asyncapi.com/docs/getting-started/coming-from-openapi)
Expand All @@ -24,23 +24,23 @@ Using JHipster Domain Language as **Ubiquitous Language** for **Data on the Insi

- **JHipster Domain Language (JDL) as Ubiquitous Language:** To describe your domain core domain model
- **API-First specs like AsyncAPI and OpenAPI:** to describe Inter Process Communications (IPC) between bounded contexts/microservices.
- **ZenWave Code Generator:** to generate (_a lot of_) infrastructure, functional and testing code from your models and APIs.
- **ZenWave SDK:** to generate (_a lot of_) infrastructure, functional and testing code from your models and APIs.

ZenWave Code Generator is designed to be easily extensible and adaptable to your project or your organization needs and likes. You can always [fork an existing, standard or custom plugin](https://github.com/ZenWave360/zenwave-sdk/#forking-an-standard-or-custom-plugin).
ZenWave SDK is designed to be easily extensible and adaptable to your project or your organization needs and likes. You can always [fork an existing, standard or custom plugin](https://github.com/ZenWave360/zenwave-sdk/#forking-an-standard-or-custom-plugin).

You can install the latest release using [jbang](https://www.jbang.dev) running the following command:

```shell
jbang alias add --fresh --name=zw release@zenwave360/zenwave-sdk
```

Please refer to [**ZenWave Code Generator**](https://github.com/ZenWave360/zenwave-sdk/) for more detailed installation options.
Please refer to [**ZenWave SDK**](https://github.com/ZenWave360/zenwave-sdk/) for more detailed installation options.

**Note:** Official plugins are designed to generate functional code and tests on top of existing projects. Creating a base project is out of scope, but you can always go to [start.spring.io](http://start.spring.io) or [start.jhipster.tech](https://start.jhipster.tech/), in case your company doesn't already have a project starter or archetype.

## Not (just) a Code Generator

ZenWave Code Generator is not a Code Generator but a **Modeling Tool** for Domain Driven Design and API-First in disguise of a _code generator_.
ZenWave SDK is a **Modeling Tool** for Domain Driven Design and API-First in disguise of a _code generator_.

Its purpose is to produce successful software projects by dramatically shortening the feedback loop between the expert domain knowledge and working software and its tests.

Expand All @@ -62,7 +62,7 @@ In this way all team members: **Domain Experts**, **Product Owners**, **Software
## Table of Contents

<!-- TOC -->
- [ZenWave Code Generator](#zenwave-sdk)
- [ZenWave SDK](#zenwave-sdk)
- [Domain Driven Design (DDD) and API-First for Event Driven Microservices](#domain-driven-design-ddd-and-api-first-for-event-driven-microservices)
- [Not (just) a Code Generator](#not-just-a-code-generator)
- [Why Domain Driven Design?](#why-domain-driven-design)
Expand Down Expand Up @@ -112,7 +112,7 @@ Whether you are:
- [Refactoring a legacy monolith](#refactoring-a-legacy-monolith) or just
- [Adding functionality on top of an existent microservices architecture](#adding-functionality-on-top-of-an-existent-microservices-archytecture)

...ZenWave Code Generator can... **generate a lot of code for you!!**
...ZenWave SDK can... **generate a lot of code for you!!**

![06-ServiceImplementation-Hexagonal](docs/06-ServiceImplementation-Hexagonal.excalidraw.svg)

Expand Down Expand Up @@ -351,7 +351,7 @@ jbang zw -p io.zenwave360.sdkns.JDLToAsyncAPIPlugin \
### Configure ZenWave Maven Plugin for AsyncAPI generation

<details open markdown="1">
<summary>ZenWave Code Generator Maven Plugin (expand to see)</summary>
<summary>ZenWave SDK Maven Plugin (expand to see)</summary>

```xml
<plugin>
Expand Down
4 changes: 2 additions & 2 deletions jbang-catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"io.github.zenwave360.zenwave-sdk.plugins:jdl-to-asyncapi:RELEASE",
"io.github.zenwave360.zenwave-sdk.plugins:jdl-openapi-controllers:RELEASE"
],
"main": "io.zenwave360.generator.Main"
"main": "io.zenwave360.sdk.Main"
},
"snapshots": {
"script-ref": "io.github.zenwave360.zenwave-sdk:zenwave-sdk-cli:1.0.0.RC1",
Expand All @@ -33,7 +33,7 @@
"mavencentral",
"snapshots\u003dhttps://s01.oss.sonatype.org/content/repositories/snapshots"
],
"main": "io.zenwave360.generator.Main"
"main": "io.zenwave360.sdk.Main"
}
},
"templates": {}
Expand Down
2 changes: 1 addition & 1 deletion plugins/asyncapi-spring-cloud-streams3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ jbang zw -p io.zenwave360.sdkns.SpringCloudStreams3Plugin --help

## Populating Headers at Runtime Automatically

ZenWave Code Generator provides `x-runtime-expression` for automatic header population at runtime. Values for this extension property are:
ZenWave SDK provides `x-runtime-expression` for automatic header population at runtime. Values for this extension property are:

- `$message.payload#/<json pointer fragment>`: follows the same format as AsyncAPI [Correlation ID](https://www.asyncapi.com/docs/reference/specification/v2.5.0#correlationIdObject) object.
- `$tracingIdSupplier`: will use the tracing id `java.function.Supplier` configured in your Spring context.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ZW> Code Generator ({{version}})
ZW> SDK ({{version}})

Available plugins:

{{#each plugins as |plugin| ~}}
{{ljust plugin.plugin.shortCode size=30 pad=" "}} {{{plugin.configClassName}}}: {{{plugin.plugin.title}}} ({{plugin.version}})
{{/each}}
{{/each}}
2 changes: 1 addition & 1 deletion zenwave-sdk-maven-plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ZenWave Code Generator Maven Plugin
# ZenWave SDK Maven Plugin
> 👉 ZenWave360 Helps You Create Software that's Easy to Understand
[![Maven Central](https://img.shields.io/maven-central/v/io.github.zenwave360.zenwave-sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.github.zenwave360.zenwave-sdk/zenwave-sdk)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.apache.maven.project.MavenProject;

/**
* Goal which generates code with the configured ZenWave Code Generator plugin.
* Goal which generates code with the configured ZenWave SDK plugin.
*/
@Mojo(name = "generate", defaultPhase = LifecyclePhase.GENERATE_SOURCES, requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME)
public class GeneratorMojo extends AbstractMojo {
Expand Down

0 comments on commit 6165e0c

Please sign in to comment.