Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: refactor of edgex docs #1212

Merged
merged 3 commits into from
Sep 8, 2023
Merged

feat: refactor of edgex docs #1212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5714b18
feat: refactor of edgex docs
jpwhitemn Sep 6, 2023
fd817ec
feat: add edgexversoinmain for references to repo work not yet in v3
jpwhitemn Sep 6, 2023
de0f0c4
feat: returned version select javascript and use of macro
jpwhitemn Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Dockerfile.docs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@

FROM python:3.10-slim

RUN pip install "mkdocs==1.4.3" \
"mkdocs-material==8.5.8" \
RUN pip install mkdocs \
"mkdocs-material==9.1.19" \
"mkdocs-htmlproofer-plugin>=0.8" \
"mkdocs-macros-plugin>=0.5" \
"mkdocs-swagger-ui-tag"
Expand Down
4 changes: 2 additions & 2 deletions docs_src/V3TopLevelMigration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,13 @@ If you have custom [environment overrides](../microservices/configuration/Common

The compose files for V3 have many changes from their V2 counter parts. If you have customized a V2 compose file to add additional services and/or add or modify configuration overrides, it is highly recommended that you start with the appropriate V3 compose file and re-add your customizations. It is very likely that the sections for your additional services will need to be migrated to have the proper environment overrides. Best approach is to use one of the V3 service sections that closest matches your service as a template.

The latest V3 compose files can be found here: [Compose Files](https://github.com/edgexfoundry/edgex-compose/tree/{{version}})
The latest V3 compose files can be found here: [Compose Files](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}})

### Compose Builder

If the additional service(s) in your custom compose file are EdgeX released device or app services, it is highly recommended that you use the Compose Builder to regenerate your custom compose file.

The latest V3 Compose Builder can be found here: [Compose Builder Readme](https://github.com/edgexfoundry/edgex-compose/tree/{{version}}/compose-builder/README.md)
The latest V3 Compose Builder can be found here: [Compose Builder Readme](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}/compose-builder/README.md)

## Command Line Options

Expand Down
267 changes: 267 additions & 0 deletions docs_src/about.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs_src/api/applications/Ch-APIAppFunctionsSDK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ The App Functions SDK provides a RESTful API that all Application Services inher

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/app-functions-sdk-go/{{version}}/openapi/{{api_version}}/app-functions-sdk.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/app-functions-sdk-go/{{edgexversion}}/openapi/{{api_version}}/app-functions-sdk.yaml"/>
2 changes: 1 addition & 1 deletion docs_src/api/core/Ch-APICoreCommand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ into two groups for each device:

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{version}}/openapi/{{api_version}}/core-command.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/core-command.yaml"/>
2 changes: 1 addition & 1 deletion docs_src/api/core/Ch-APICoreData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ EdgeX Foundry Core Data microservice includes the Events/Readings database colle

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{version}}/openapi/{{api_version}}/core-data.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/core-data.yaml"/>

2 changes: 1 addition & 1 deletion docs_src/api/core/Ch-APICoreMetadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ this service's API. See [Core Metadata](../../microservices/core/metadata/Ch-Met

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{version}}/openapi/{{api_version}}/core-metadata.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/core-metadata.yaml"/>
2 changes: 1 addition & 1 deletion docs_src/api/devices/Ch-APIDeviceSDK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ The Device Service SDK provides a RESTful API that all Device Services inherit f

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/device-sdk-go/{{version}}/openapi/{{api_version}}/device-sdk.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/device-sdk-go/{{edgexversion}}/openapi/{{api_version}}/device-sdk.yaml"/>
2 changes: 1 addition & 1 deletion docs_src/api/support/Ch-APISupportNotifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ When a person or a system needs to be informed of something discovered on the no

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{version}}/openapi/{{api_version}}/support-notifications.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/support-notifications.yaml"/>
2 changes: 1 addition & 1 deletion docs_src/api/support/Ch-APISupportScheduler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ EdgeX Foundry's Support Scheduler microservice to schedule actions to occur on s

## Swagger

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{version}}/openapi/{{api_version}}/support-scheduler.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/edgex-go/{{edgexversion}}/openapi/{{api_version}}/support-scheduler.yaml"/>
4 changes: 0 additions & 4 deletions docs_src/assets/stylesheets/branding.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,3 @@
--md-code-bg-color: hsla(0, 0%, 92.5%, 0.5);
--md-code-fg-color: hsla(200, 18%, 26%, 1);
}

.md-header, .md-tabs {
background-color: var(--md-accent-fg-color);
}
36 changes: 36 additions & 0 deletions docs_src/assets/stylesheets/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.home-nav-column {
float: left;
width: 30%;
padding: 0 10px;
border-top: 5px solid hsla(282,65%,19%,1);
margin: 5px 5px;
}
.home-nav-card {
text-align: center;
}

.home-nav-row {
margin: 0 -5px;
}

.home-nav-row:after {
content: "";
display: table;
clear: both;
}

.divider {
border-top: 3px solid hsla(282,65%,19%,1);
padding-bottom: 0px;
}

.home-nav-icons {
vertical-align: middle;
height: 50px;
width: 50px;
margin-right: 0px;
}

.md-header, .md-tabs {
background-color: hsla(282,65%,19%,1);
}
Binary file added docs_src/cloud-upload.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs_src/design/legacy-design/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@
| -------------------------------------------------- | -------------------------------------------- |
| [Registry Abstraction](Registry-Abstraction.pdf) | Decouple EdgeX services from Consul |
| [device-service/Discovery](device-service/discovery.md) | Dynamically discover new devices |
| | |
| | |
2 changes: 0 additions & 2 deletions docs_src/design/legacy-requirements/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@
| Name/Link | Short Description |
| -------------------------------------------------- | -------------------------------------------- |
| [Device Service](device-service.md) | Device Service SDK required functionality |
| | |
| | |

Binary file added docs_src/docker.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 18 additions & 18 deletions docs_src/examples/AppServiceExamples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# App Service Examples

The following is a list of examples we currently have available that demonstrate various ways that the **Application Functions SDK** or **App Service Configurable** can be used. All of the examples
can be found here in the [edgex-examples](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services) repo. They focus on how to leverage various built in provided functions as mentioned above as well as how to write your own in the case that the SDK does not provide what is needed.
can be found here in the [edgex-examples](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services) repo. They focus on how to leverage various built in provided functions as mentioned above as well as how to write your own in the case that the SDK does not provide what is needed.

| <div style="width:250px">Example Name</div> | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Camera Management](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/camera-management) | Utilizes the ONVIF and USB device services and demonstrates the management of these cameras and their integration with video inferencing |
| [Simple Filter XML](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/simple-filter-xml) | Demonstrates Filtering of Events by Device names and transforming data to XML |
| [Simple Filter XML HTTP](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/simple-filter-xml-http) | Same example as #1, but result published to HTTP Endpoint |
| [Simple Filter XML MQTT](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/simple-filter-xml-mqtt) | Same example as #1, but result published to MQTT Broker |
| [Simple CBOR Filter](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/simple-cbor-filter) | Demonstrates Filtering of Events by Resource names for Event that is CBOR encoded containing a binary reading |
| [Advanced Filter Convert Publish](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/advanced-filter-convert-publish) | Demonstrates Filtering of Events by Resource names, custom function to convert the reading and them publish the modified Event back to the MessageBus under a different topic. |
| [Advanced Target Type](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/advanced-target-type) | Demonstrates use of custom Target Type and use of HTTP Trigger |
| [Cloud Export MQTT](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/cloud-export-mqtt) | Demonstrates simple custom Cloud transform and exporting to Cloud MQTT Broker. |
| [Cloud Event Transform](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/cloud-event) | Demonstrates custom transforms that convert Event/Readings to and from Cloud Events |
| [Send Command](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/send-command) | Demonstrates sending commands to a Device via the Command Client. |
| [Secrets](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/secrets) | Demonstrates how to retrieve secrets from the service SecretStore |
| [Custom Trigger](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/custom-trigger) | Demonstrates how to create and use a custom trigger |
| [NATS RPC](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/custom-trigger-nats-rpc) | Demonstrates how to create a synchronous request/reply trigger using NATS messaging |
| [Fledge Export](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/fledge-export) | Demonstrates custom conversion of Event/Reading to Fledge format and then exporting to Fledge service REST endpoint |
| [Influxdb Export](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/influxdb-export) | Demonstrates custom conversion of Event/Reading to InfluxDB timeseries format and then exporting to InFluxDB via MQTT |
| [Json Logic](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/custom/json-logic) | Demonstrates using the built in JSONLogic Evaluate pipeline function |
| [IBM Export Profile](https://github.com/edgexfoundry/edgex-examples/tree/{{version}}/application-services/configurable/app-service-configurable-ibm) | Demonstrates a custom App Service Configurable profile for exporting to IBM Cloud |
| [Camera Management](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/camera-management) | Utilizes the ONVIF and USB device services and demonstrates the management of these cameras and their integration with video inferencing |
| [Simple Filter XML](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/simple-filter-xml) | Demonstrates Filtering of Events by Device names and transforming data to XML |
| [Simple Filter XML HTTP](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/simple-filter-xml-http) | Same example as #1, but result published to HTTP Endpoint |
| [Simple Filter XML MQTT](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/simple-filter-xml-mqtt) | Same example as #1, but result published to MQTT Broker |
| [Simple CBOR Filter](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/simple-cbor-filter) | Demonstrates Filtering of Events by Resource names for Event that is CBOR encoded containing a binary reading |
| [Advanced Filter Convert Publish](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/advanced-filter-convert-publish) | Demonstrates Filtering of Events by Resource names, custom function to convert the reading and them publish the modified Event back to the MessageBus under a different topic. |
| [Advanced Target Type](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/advanced-target-type) | Demonstrates use of custom Target Type and use of HTTP Trigger |
| [Cloud Export MQTT](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/cloud-export-mqtt) | Demonstrates simple custom Cloud transform and exporting to Cloud MQTT Broker. |
| [Cloud Event Transform](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/cloud-event) | Demonstrates custom transforms that convert Event/Readings to and from Cloud Events |
| [Send Command](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/send-command) | Demonstrates sending commands to a Device via the Command Client. |
| [Secrets](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/secrets) | Demonstrates how to retrieve secrets from the service SecretStore |
| [Custom Trigger](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/custom-trigger) | Demonstrates how to create and use a custom trigger |
| [NATS RPC](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/custom-trigger-nats-rpc) | Demonstrates how to create a synchronous request/reply trigger using NATS messaging |
| [Fledge Export](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/fledge-export) | Demonstrates custom conversion of Event/Reading to Fledge format and then exporting to Fledge service REST endpoint |
| [Influxdb Export](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/influxdb-export) | Demonstrates custom conversion of Event/Reading to InfluxDB timeseries format and then exporting to InFluxDB via MQTT |
| [Json Logic](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/custom/json-logic) | Demonstrates using the built in JSONLogic Evaluate pipeline function |
| [IBM Export Profile](https://github.com/edgexfoundry/edgex-examples/tree/{{edgexversion}}/application-services/configurable/app-service-configurable-ibm) | Demonstrates a custom App Service Configurable profile for exporting to IBM Cloud |

2 changes: 1 addition & 1 deletion docs_src/examples/Ch-ExamplesAddingSNMPDevice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you have not already done so, proceed to [Getting Started using Docker](../ge
The EdgeX docker-compose.yml file used to run EdgeX must include the SNMP device service for this example. You can either:

- download and use the [docker-compose.yml](./docker-compose.yml) file provided with this example
- or use the [EdgeX Compose Builder tool](https://github.com/edgexfoundry/edgex-compose/tree/{{version}}/compose-builder) to create your own custom docker-compose.yml file adding device-snmp.
- or use the [EdgeX Compose Builder tool](https://github.com/edgexfoundry/edgex-compose/tree/{{edgexversion}}/compose-builder) to create your own custom docker-compose.yml file adding device-snmp.

See [Getting Started using Docker](../getting-started/Ch-GettingStartedDockerUsers.md#run-edgex-foundry) if you need assistance running EdgeX once you have your Docker Compose file.

Expand Down
Loading