Skip to content

Commit 549b55e

Browse files
authored
Fixed links to documentation (#23)
* Fixed links to documentation * Fixes * Fixes to host * Fix MM * Fixes * Fixes * Fixes * Fixes
1 parent 13ed03f commit 549b55e

6 files changed

Lines changed: 113 additions & 114 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ Navigate through the folders to get started, develop, and contribute to Edge Inf
2222

2323
Last Updated Date: March 13, 2025
2424

25-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
26-
[resource-managers-architecture-url]: https://intel.com
25+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
26+
[resource-managers-architecture-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/arch/orchestrator/architecture.html

host/README.md

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111

1212
## Overview
1313

14-
The purpose of the Host Manager is to manage a host’s hardware information and It also implements connection tracking
14+
The purpose of the Host Resource Manager is to manage a host’s hardware information. It also implements connection tracking
1515
and reconciliation.
16-
Host Resource Manager collects all of this data, such as CPU, Memory, Disk, GPU, Interfaces and such, with the help
16+
The Host Resource Manager collects all of this data, such as CPU, Memory, Disk, GPU, Interfaces and such, with the help
1717
of Hardware Discovery Agent (HDA) on the Edge Node.
18-
The Host Resource Manager stores this data in inventory so that other components (like UI and Cluster Orchestration)
18+
The Host Resource Manager stores this data in the Inventory so that other components (like UI and Cluster Orchestration)
1919
can retrieve and act on it.
2020

21-
Host Manager uses TLS with JWT (Json Web Tokens) technology to make the communication from the orchestrator to the edge
22-
node secure.
21+
The Host Resource Manager uses TLS with JWT (Json Web Tokens) technology to make the communication from the orchestrator
22+
to the edge node secure.
2323

2424
## Features
2525

@@ -29,7 +29,7 @@ node secure.
2929

3030
## Get Started
3131

32-
Instructions on how to install and set up host Resource Manager on your development machine.
32+
Instructions on how to install and set up the Host Resource Manager on your development machine.
3333

3434
### Dependencies
3535

@@ -42,19 +42,19 @@ make dependency-check
4242

4343
This code requires the following tools to be installed on your development machine:
4444

45-
- [Go\* programming language](https://go.dev) - check [$GOVERSION_REQ](Makefile)
46-
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](Makefile)
47-
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](Makefile)
48-
- [gocover-cobertura](github.com/boumenot/gocover-cobertura) - check [$GOCOBERTURAVERSION_REQ](Makefile)
49-
- [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) - check [$PROTOCGENDOCVERSION_REQ](Makefile)
50-
- [buf](https://github.com/bufbuild/buf) - check [$BUFVERSION_REQ](Makefile)
51-
- [protoc-gen-go](https://pkg.go.dev/google.golang.org/protobuf) - check [$PROTOCGENGOVERSION_REQ](Makefile)
52-
- [protoc-gen-go-grpc](https://pkg.go.dev/google.golang.org/grpc) - check [$PROTOCGENGOGRPCVERSION_REQ](Makefile)
53-
- [gnostic](https://pkg.go.dev/github.com/google/gnostic) - check [GNOSTICVERSION_REQ](Makefile)
54-
- [protoc-gen-validate](https://pkg.go.dev/github.com/envoyproxy/protoc-gen-validate) - check [PROTOCGENVALIDATEGOVERSION_REQ](Makefile)
55-
- [gnostic-grpc](https://pkg.go.dev/github.com/googleapis/gnostic-grpc) - check [GNOSTICGRPCVERSION_REQ](Makefile)
45+
- [Go\* programming language](https://go.dev) - check [$GOVERSION_REQ](../version.mk)
46+
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](../version.mk)
47+
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](../version.mk)
48+
- [gocover-cobertura](https://github.com/boumenot/gocover-cobertura) - check [$GOCOBERTURAVERSION_REQ](../version.mk)
49+
- [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) - check [$PROTOCGENDOCVERSION_REQ](../version.mk)
50+
- [buf](https://github.com/bufbuild/buf) - check [$BUFVERSION_REQ](../version.mk)
51+
- [protoc-gen-go](https://pkg.go.dev/google.golang.org/protobuf) - check [$PROTOCGENGOVERSION_REQ](../version.mk)
52+
- [protoc-gen-go-grpc](https://pkg.go.dev/google.golang.org/grpc) - check [$PROTOCGENGOGRPCVERSION_REQ](../version.mk)
53+
- [gnostic](https://pkg.go.dev/github.com/google/gnostic) - check [GNOSTICVERSION_REQ](../version.mk)
54+
- [protoc-gen-validate](https://pkg.go.dev/github.com/envoyproxy/protoc-gen-validate) - check [PROTOCGENVALIDATEGOVERSION_REQ](../version.mk)
55+
- [gnostic-grpc](https://pkg.go.dev/github.com/googleapis/gnostic-grpc) - check [GNOSTICGRPCVERSION_REQ](../version.mk)
5656
- [protoc-gen-grpc-gateway](https://pkg.go.dev/github.com/grpc-ecosystem/grpc-gateway/v2@v2.26.0/protoc-gen-grpc-gateway)
57-
- check [PROTOCGENGRPCGATEWAY_REQ](Makefile)
57+
- check [PROTOCGENGRPCGATEWAY_REQ](../version.mk)
5858

5959
You can install Go dependencies by running `make go-dependency`.
6060

@@ -71,14 +71,13 @@ The binary is installed in the [$OUT_DIR](../common.mk) folder.
7171

7272
## Usage
7373

74-
This guide shows how to deploy Host Resource Manger for local development or testing.
74+
This guide shows how to deploy the Host Resource Manger for local development or testing.
7575
For production deployments use the [Edge Infrastructure Manager charts][inframanager-charts].
7676

77-
> Note: To run host manager, Inventory need to be running as the host manager need to register as an inventory client.
78-
> Please refer to the TODO
79-
> [instruction of Inventory](https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage)
80-
> and [Database in Inventory](https://github.com/open-edge-platform/infra-core/blob/main/inventory/docs/database.md)
81-
> for more information about how to run inventory.
77+
> Note: To run the Host Resource Manager, Inventory must be running as the manager needs to register as an Inventory client.
78+
> Please refer to the [Inventory instructions](https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage)
79+
> and [database in Inventory](https://github.com/open-edge-platform/infra-core/blob/main/inventory/docs/database.md)
80+
> for more information about how to run Inventory.
8281
8382
### Run Host Resource Manager
8483

@@ -88,11 +87,11 @@ make go-run
8887

8988
See the [documentation][user-guide-url] if you want to learn more about using Edge Orchestrator.
9089

91-
For any issues the [Troubleshooting guide][troubleshooting-url].
90+
For any issues, refer to the [Troubleshooting guide][troubleshooting-url].
9291

9392
## Functional Test
9493

95-
Run the make target `test` to mock agents to perform the relative behaviors for host resources.
94+
Run the make target `test` to mock agents to simulate the relative behaviors for host resources.
9695

9796
```bash
9897
make test
@@ -118,11 +117,11 @@ targets. The following is a list of makefile targets that support developer acti
118117
For additional information:
119118

120119
- See the [docs](docs/api/hostmgr.md) for the Host Resource Manager APIs
121-
- See[Edge Infrastructure Manager developer documentation][inframanager-dev-guide-url] for internals and
120+
- See [Edge Infrastructure Manager developer documentation][inframanager-dev-guide-url] for internals and
122121
software architecture.
123122

124-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
125-
[inframanager-dev-guide-url]: (https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html)
126-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
127-
[troubleshooting-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/troubleshooting/troubleshooting.html
123+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
124+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
125+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
126+
[troubleshooting-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/troubleshooting/index.html
128127
[inframanager-charts]: https://github.com/open-edge-platform/infra-charts

maintenance/README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,27 @@
1212
## Overview
1313

1414
The Maintenance Manager service is designed to help manage maintenance tasks for Edge Nodes.
15-
Maintenance Manager acts as a bridge, passing down the maintenance and update requests (Schedules) to the
15+
It acts as a bridge, passing down the maintenance and update requests (Schedules) to the
1616
managed Edge Nodes. This service is responsible for ensuring that Edge Nodes can perform the required maintenance
1717
and update tasks.
1818

19-
Maintenance manager handles `schedule` resources are used to model time-based events, such as administrative downtime,
19+
The Maintenance Manager handles `schedule` resources used to model time-based events, such as administrative downtime,
2020
maintenance windows, or other events that may happen either a single time or repeated on a schedule.
2121

22-
For more information on the schedule and how this trasnalte on the Edge Node please check
22+
For more information on the schedule and how this trasnaltes on the Edge Node please check
2323
the [Schedule](docs/schedule.md).
2424

2525
## Features
2626

2727
- Top-down Edge Node maintenance scheduling, one off or recurring at specific times
2828
- Single or per-group Edge Node updates
29-
- Mutable OS Update: Day 2 update of mutable Ubuntu OS using apt package manager (as per past releases).
30-
- Immutable OS Update: Day 2 update of immutable Edge Microvisor Toolkit via A/B partition swap and install of new OS image.
29+
- Mutable OS Update: Day 2 update of the mutable Ubuntu OS using APT package manager (as per past releases).
30+
- Immutable OS Update: Day 2 update of the immutable Edge Microvisor Toolkit via A/B partition swap and installation
31+
of a new OS image.
3132

3233
## Get Started
3334

34-
Instructions on how to install and set up Maintenance Manger on your development machine.
35+
Instructions on how to install and set up the Maintenance Manger on your development machine.
3536

3637
### Dependencies
3738

@@ -44,15 +45,15 @@ make dependency-check
4445

4546
This code requires the following tools to be installed on your development machine:
4647

47-
- [Go\* programming language](https://go.dev) - check [$GOVERSION_REQ](Makefile)
48-
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](Makefile)
49-
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](Makefile)
50-
- [gocover-cobertura](github.com/boumenot/gocover-cobertura) - check [$GOCOBERTURAVERSION_REQ](Makefile)
51-
- [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) - check [$PROTOCGENDOCVERSION_REQ](Makefile)
52-
- [buf](https://github.com/bufbuild/buf) - check [$BUFVERSION_REQ](Makefile)
53-
- [protoc-gen-go](https://pkg.go.dev/google.golang.org/protobuf) - check [$PROTOCGENGOVERSION_REQ](Makefile)
54-
- [protoc-gen-go-grpc](https://pkg.go.dev/google.golang.org/grpc) - check [$PROTOCGENGOGRPCVERSION_REQ](Makefile)
55-
- [protoc-gen-validate](https://pkg.go.dev/github.com/envoyproxy/protoc-gen-validate) - check [PROTOCGENVALIDATEGOVERSION_REQ](Makefile)
48+
- [Go\* programming language](https://go.dev) - check [$GOVERSION_REQ](../version.mk)
49+
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](../version.mk)
50+
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](../version.mk)
51+
- [gocover-cobertura](https://github.com/boumenot/gocover-cobertura) - check [$GOCOBERTURAVERSION_REQ](../version.mk)
52+
- [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) - check [$PROTOCGENDOCVERSION_REQ](../version.mk)
53+
- [buf](https://github.com/bufbuild/buf) - check [$BUFVERSION_REQ](../version.mk)
54+
- [protoc-gen-go](https://pkg.go.dev/google.golang.org/protobuf) - check [$PROTOCGENGOVERSION_REQ](../version.mk)
55+
- [protoc-gen-go-grpc](https://pkg.go.dev/google.golang.org/grpc) - check [$PROTOCGENGOGRPCVERSION_REQ](../version.mk)
56+
- [protoc-gen-validate](https://pkg.go.dev/github.com/envoyproxy/protoc-gen-validate) - check [PROTOCGENVALIDATEGOVERSION_REQ](../version.mk)
5657

5758
You can install Go dependencies by running `make go-dependency`.
5859

@@ -72,11 +73,10 @@ The binary is installed in the [$OUT_DIR](../common.mk) folder.
7273
This guide shows how to deploy Maintenance Manger for local development or testing.
7374
For production deployments use the [Edge Infrastructure Manager charts][inframanager-charts].
7475

75-
> Note: To run host manager, Inventory need to be running as the host manager need to register as an inventory client.
76-
> Please refer to the TODO
77-
> [instruction of Inventory](https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage)
76+
> Note: To run the Maintenance Manager, Inventory must be running as the manager needs to register as an Inventory client.
77+
> Please refer to [Inventory instructions](https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage)
7878
> and [Database in Inventory](https://github.com/open-edge-platform/infra-core/blob/main/inventory/docs/database.md)
79-
> for more information about how to run inventory.
79+
> for more information about how to run Inventory.
8080
8181
### Run Maintenance Manger
8282

@@ -90,7 +90,7 @@ For any issues see the [Troubleshooting guide][troubleshooting-url].
9090

9191
## Functional Test
9292

93-
Run the make target `test` to mock agents to perform the relative behaviors for host resources.
93+
Run the make target `test` to mock agents to simulate the relative behaviors for host resources.
9494

9595
```bash
9696
make test
@@ -141,8 +141,8 @@ For additional information:
141141
- See[Edge Infrastructure Manager developer documentation][inframanager-dev-guide-url] for internals and
142142
software architecture.
143143

144-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
145-
[inframanager-dev-guide-url]: (https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html)
146-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
147-
[troubleshooting-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/troubleshooting/troubleshooting.html
144+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
145+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
146+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
147+
[troubleshooting-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/troubleshooting/index.html
148148
[inframanager-charts]: https://github.com/open-edge-platform/infra-charts

networking/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
## Overview
1313

14-
The Networking manager constantly verifies the correctness of the networking configuration and IP
14+
The Networking Manager constantly verifies the correctness of the networking configuration and IP
1515
uniqueness on of the Edge Nodes within a site.
1616

1717
The Networking Manager handles Network Resources representing the network infrastructure of a site and its
@@ -42,9 +42,9 @@ make dependency-check
4242

4343
This code requires the following tools to be installed on your development machine:
4444

45-
- [Go\* programming language](https://go.dev) - check [$GOVERSION_REQ](Makefile)
46-
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](Makefile)
47-
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](Makefile)
45+
- [Go\* programming language](https://go.dev) - check [$GOVERSION_REQ](../version.mk)
46+
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](../version.mk)
47+
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](../version.mk)
4848

4949
You can install Go dependencies by running `make go-dependency`.
5050

@@ -64,11 +64,11 @@ The binary is installed in the [$OUT_DIR](../common.mk) folder.
6464
This guide shows how to deploy Networking Manger for local development or testing.
6565
For production deployments use the [Edge Infrastructure Manager charts][inframanager-charts].
6666

67-
> Note: To run host manager, Inventory need to be running as the host manager need to register as an inventory client.
68-
> Please refer to the TODO
69-
> [instruction of Inventory](https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage)
67+
> Note: To run the Networking Manager, Inventory must to be running as the manager needs to register as an Inventory client.
68+
> Please refer to the
69+
> [Inventory instructions](https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage)
7070
> and [Database in Inventory](https://github.com/open-edge-platform/infra-core/blob/main/inventory/docs/database.md)
71-
> for more information about how to run inventory.
71+
> for more information about how to run Inventory.
7272
7373
### Run Networking Manger
7474

@@ -80,7 +80,7 @@ See the [documentation][user-guide-url] if you want to learn more about using Ed
8080

8181
## Functional Test
8282

83-
Run the make target `test` to mock agents to perform the relative behaviors for host resources.
83+
Run the make target `test` to mock agents to simulate the relative behaviors for host resources.
8484

8585
```bash
8686
make test
@@ -105,8 +105,8 @@ targets. The following is a list of makefile targets that support developer acti
105105
- `build` to build the project and generate executable files
106106
- `docker-build` to build the Inventory Docker container
107107

108-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
109-
[inframanager-dev-guide-url]: (https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html)
110-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
111-
[troubleshooting-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/troubleshooting/troubleshooting.html
108+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
109+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
110+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
111+
[troubleshooting-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/troubleshooting/index.html
112112
[inframanager-charts]: https://github.com/open-edge-platform/infra-charts

0 commit comments

Comments
 (0)