Skip to content

Commit

Permalink
refactor: Rework App SDK docs layout/structure - Phase 1 (#1248)
Browse files Browse the repository at this point in the history
* refactor: Rework App SDK docs layout/structure - Phase 1

Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
  • Loading branch information
Lenny Goodell authored Oct 18, 2023
1 parent a09965f commit e9e6794
Show file tree
Hide file tree
Showing 30 changed files with 336 additions and 300 deletions.
11 changes: 0 additions & 11 deletions docs_src/api/applications/Ch-APIAppFunctionsSDK.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs_src/design/adr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ At the root of this folder are decisions that are relevant to multiple parts of

## Naming and Formatting
ADR documents should follow the RFC (request for comments) naming standard. Specifically, approved ADRs should have a sequentially increasing integer (or serial number) and then the architectural design topic as file names (sequence_number-My-Topic.md). Example: 0001-Separate-Configuration-Interface. The sequence is a global sequence for all EdgeX ADR.
Per RFC and Michael Nygard [suggestions](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-by-michael-nygard/index.md) the makeup of the ADR document should generally include:
Per RFC and Michael Nygard [suggestions](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/locales/en/templates/decision-record-template-by-michael-nygard/index.md) the makeup of the ADR document should generally include:

- Title
- Status (proposed, accepted, rejected, deprecated, superseded, etc.)
Expand Down
9 changes: 5 additions & 4 deletions docs_src/general/ServiceConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,19 @@ Please refer to the general [Common Configuration documentation](../microservice
|support-notifications |[Support Notifications Configuration](../microservices/support/notifications/Ch-AlertsNotifications.md#configuration-properties)|
|support-scheduler| [Support Scheduler Configuration](../microservices/support/scheduler/Ch-Scheduler.md#configuration-properties)|
=== "Application & Analytics"
|Services Name| Configuration Reference|
|Service Name| Configuration Reference|
|---|---|
|app-service|[General Application Service Configuration](../microservices/application/GeneralAppServiceConfig.md)|
|app-service|[General Application Service Configuration](../microservices/application/Configuration.md)|
|app-service-configurable|[Configurable Application Service Configuration](../microservices/application/services/AppServiceConfigurable/Configuration.md)|
|app-record-replay|[App Record Replay Configuration](../microservices/application/services/AppRecordReplay/Configuration.md)|
|eKuiper rules engine/eKuiper|[Basic eKuiper Configuration](https://github.com/lf-edge/ekuiper/blob/7ef3a19366ee1f4537747fdc2e574389225f5d51/docs/en_US/operation/config/configuration_file.md)|
=== "Device"
|Services Name| Configuration Reference|
|Service Name| Configuration Reference|
|---|---|
|device-service |[General Device Service Configuration](../microservices/device/Ch-DeviceServices.md#configuration-properties)|
|device-virtual |[Virtual Device Service Configuration](../microservices/device/services/device-virtual/Ch-VirtualDevice.md#configuration-properties)|
=== "Security"
|Services Name| Configuration Reference|
|Service Name| Configuration Reference|
|---|---|
|API Gateway|[API Gateway Configuration](../security/Ch-APIGateway.md#configuring-api-gateway)|
|Add-on Services |[Configuring Add-on Service](../security/Ch-Configuring-Add-On-Services.md)|
6 changes: 3 additions & 3 deletions docs_src/getting-started/Ch-GettingStartedGoDevelopers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ These instructions are for Go Lang Developers and Contributors to get, run and o
micro services. Before reading this guide, review the general [developer requirements](./Ch-GettingStartedDevelopers.md#what-you-need).

If you want to get the EdgeX platform and run it (but do not intend to change or add to the existing code base now) then you are considered a "User". Users should read:
[Getting Started as a User](./Ch-GettingStartedUsers.md))
[Getting Started as a User](./Ch-GettingStartedUsers.md)

## What You Need For Go Development

Expand All @@ -25,7 +25,7 @@ issues (EdgeX now uses Go Modules which were introduced with Go Lang

### Build Essentials

In order to compile and build some elements of EdgeX, Gnu C compiler, utilities (like make), and associated librarires need to be installed. Some [IDEs](#ide-optional) may already come with these tools. Some OS environments may already come with these tools. Others environments may require you install them. For Ubuntu environments, you can install a convenience package called [Build Essentials](https://packages.ubuntu.com/bionic/build-essential).
In order to compile and build some elements of EdgeX, Gnu C compiler, utilities (like make), and associated libraries need to be installed. Some [IDEs](#ide-optional) may already come with these tools. Some OS environments may already come with these tools. Others environments may require you install them. For Ubuntu environments, you can install a convenience package called [Build Essentials](https://packages.ubuntu.com/bionic/build-essential).

!!! Note
If you are installing Build Essentials, note that there is a build-essential package for each Ubuntu release. Search for 'build-essential' associated to your Ubuntu version via [Ubuntu Packages Search](https://packages.ubuntu.com/).
Expand Down Expand Up @@ -180,7 +180,7 @@ See [EdgeX Default Service Ports](../../general/ServicePorts) for a list of the
## Next Steps
Application services and some device services are also built in Go. To explore how to create and build EdgeX application and devices services in Go, head to SDK documentation covering these EdgeX elements.

- [Application Services and the Application Functions SDK](./ApplicationFunctionsSDK.md)
- [Application Services and the Application Functions SDK](../microservices/application/sdk/GettingStarted.md)
- [Device Services in Go](./Ch-GettingStartedSDK-Go.md)

## EdgeX Foundry in GoLand
Expand Down
8 changes: 4 additions & 4 deletions docs_src/getting-started/tools/Ch-GUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,10 +315,10 @@ When the application service is a configurable app service and is known to the G

There are four tabs in the Configurable Setting editor:

- [Trigger](../../microservices/application/Triggers.md) which defines how the configurable app service begins execution
- [Pipeline Functions](../../microservices/application/BuiltIn.md) defining which functions are part of the configurable app service pipeline and in which order should they be executed
- [Insecure Secrets](../../microservices/application/AdvancedTopics.md#secrets) - setting up secrets used by the configurable app service when running in non-secure mode (meaning Vault is not used to provide the secrets)
- [Store and Forward](../../microservices/application/AdvancedTopics.md#store-and-forward) which enables and configures the batch store and forward export capability
- [Trigger](../../microservices/application/sdk/details/Triggers.md) which defines how the configurable app service begins execution
- [Pipeline Functions](../../microservices/application/sdk/api/BuiltInPipelineFunctions.md) defining which functions are part of the configurable app service pipeline and in which order should they be executed
- [Insecure Secrets](../../microservices/application/sdk/details/AdvancedTopics.md#secrets) - setting up secrets used by the configurable app service when running in non-secure mode (meaning Vault is not used to provide the secrets)
- [Store and Forward](../../microservices/application/sdk/details/AdvancedTopics.md#store-and-forward) which enables and configures the batch store and forward export capability

!!! Note
When the Trigger is changed, the service must be restarted for the change to take effect.
Expand Down
9 changes: 9 additions & 0 deletions docs_src/microservices/application/ApiReference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: App Services - API Reference
---

# Application Services - API Reference

The following REST APIs are provided by the App SDK and are inherited by all Application Services.

<swagger-ui src="https://github.com/raw/edgexfoundry/app-functions-sdk-go/{{edgexversion}}/openapi/{{api_version}}/app-functions-sdk.yaml"/>
18 changes: 0 additions & 18 deletions docs_src/microservices/application/ApplicationFunctionsSDK.md

This file was deleted.

Loading

0 comments on commit e9e6794

Please sign in to comment.