Skip to content

Commit dbdab65

Browse files
authored
Fixed links to documentation (#40)
* Fixed links to documentation * Bump versions
1 parent a5ec991 commit dbdab65

File tree

8 files changed

+36
-31
lines changed

8 files changed

+36
-31
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Manager.
2121

2222
Last Updated Date: January 10, 2025
2323

24-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
24+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html

bulk-import-tools/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Edge Infrastructure Manager.
1616
1. orch-host-preflight
1717
2. orch-host-bulk-import
1818

19-
The former is used to pre-check data and the latter is used, once the data, have been validated to import the data in
19+
The former is used to pre-check the data and the latter is used, once the data have been validated, to import the data into
2020
Edge Infrastructure Manager using the Northboud REST APIs.
2121

2222
## Features
2323

24-
- Automate and reduce the number of individual steps required to add multiple new hosts
25-
- Reduce the likelihood of data entry problems and human error in the process
24+
- Automated and reduced the number of individual steps required to add multiple new hosts
25+
- Reduced the likelihood of data entry problems and human error in the process
2626
- Support for well-known CSV files that are used to inject data into the tools
2727
- Built with the support for Multitenancy
2828

@@ -39,7 +39,7 @@ installed on your development machine:
3939
- [golangci-lint](https://github.com/golangci/golangci-lint) - check [$GOLINTVERSION_REQ](../version.mk)
4040
- [go-junit-report](https://github.com/jstemmer/go-junit-report) - check [$GOJUNITREPORTVERSION_REQ](../version.mk)
4141
- Python\* programming language version 3.10 or later
42-
- [gocover-cobertura](github.com/boumenot/gocover-cobertura) - check [$GOCOBERTURAVERSION_REQ](../version.mk)
42+
- [gocover-cobertura](https://github.com/boumenot/gocover-cobertura) - check [$GOCOBERTURAVERSION_REQ](../version.mk)
4343

4444
### Build the Binary
4545

@@ -57,8 +57,7 @@ The binaries are installed in the [$OUT_DIR](../common.mk) folder:
5757

5858
### Usage
5959

60-
Tools run as standalone binary and there are no difference when deploying in production or during developement and
61-
testing phases.
60+
Tools run as standalone binaries and their deployment process is consistent across production, development, and testing phases.
6261

6362
#### Pre-flight tool
6463

@@ -216,6 +215,8 @@ See the [docs](docs) for advanced development topics:
216215
To learn more about internals and software architecture, see
217216
[Edge Infrastructure Manager developer documentation][inframanager-dev-guide-url].
218217

219-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
220-
[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)
221-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
218+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
219+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
220+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
221+
222+
Last Updated Date: April 10, 2025

exporters-inventory/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010

1111
## Overview
1212

13-
This sub-repository contains the Observability exporter for Inventory service. It exports, using a
13+
This sub-repository contains the Observability exporter for the Inventory service. It exports, using a
1414
[Prometheus\* toolkit](https://prometheus.io/)-compatible interface, some Inventory metrics that cannot be collected
1515
directly from the edge node software.
1616

1717
## Features
1818

1919
- Prometheus* compatible northbound APIs
20-
- Export active maintanance window indication
21-
- Export host status information such as provisioning, onboarding and update statuses
22-
- Export edge device specific information such as hostname, serial number, UUID
20+
- Exportes active maintanance window indication
21+
- Exportes host status information such as provisioning, onboarding and update statuses
22+
- Exportes edge device specific information such as hostname, serial number, UUID
2323
- Built with the support for Multitenancy
2424
- Flexible deployments that span from a standalone binary to container-based orchestrations
2525

@@ -97,7 +97,7 @@ To learn more about internals and software architecture, see
9797

9898
To run the integration tests for Inventory Exporter, please refer to this [README](test/README.md).
9999

100-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
101-
[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)
102-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
100+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
101+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
102+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
103103
[inframanager-charts]: https://github.com/open-edge-platform/infra-charts

inventory/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ exported packages. See the documentation for the exported packages, as follows:
149149

150150
Note that the documentation also contains runnable examples that demonstrate how to use those libraries in your code.
151151

152-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
153-
[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)
154-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
152+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
153+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
154+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
155155
[inframanager-charts]: https://github.com/open-edge-platform/infra-charts

inventory/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.23.2
1+
2.23.3-dev

os-profiles/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Currently, supported Operating Systems, with their profiles are:
1818
- Intel's Edge Microvisor Toolkit v 3.0 based on Azure Linux, with 2 variantes, a non Real Time (`nonrt`) and
1919
Real time (`rt`) kernel.
2020

21-
For more information on OS Profiles please visit TODO LINK.
21+
For more information on OS Profiles please visit [the guide on the OS profiles][os-profiles].
2222
To learn how to manage OS profiles and manually push them to change elements or testing refer to the
2323
[Manage OS profiles guide](docs/Manage_OS_profiles.md)
2424

@@ -27,13 +27,13 @@ To learn how to manage OS profiles and manually push them to change elements or
2727
- Definition of Operating Systems available to be used during Edge Node deployment
2828
- Support for different images and security features
2929
- Profiles are Versioned for release mapping
30-
- Support mutable and immutable Operating System
31-
- Support custom OS dependencies and installation procedures via `Platform Bundle`
32-
- Expose Security feature capabilities and known installed packages.
30+
- Support for mutable and immutable Operating System
31+
- Support for custom OS dependencies and installation procedures via `Platform Bundle`
32+
- Exposed Security feature capabilities and known installed packages.
3333

3434
## Contribute
3535

36-
To learn how to contribute to the project, see the contributor's guide//TODOcontributors-guide-url]. The project will
36+
To learn how to contribute to the project, see [the contributor's guide][contributors-guide-url]. The project will
3737
accept contributions through Pull-Requests (PRs). PRs must be built successfully by the CI pipeline, pass linters
3838
verifications and the unit tests.
3939

@@ -47,4 +47,8 @@ See the [docs](docs) for advanced development topics:
4747
- [Manage OS profiles guide](docs/Manage_OS_profiles.md)
4848

4949
To learn more about internals and software architecture, see
50-
//TODOEdge Infrastructure Manager developer documentation][inframanager-dev-guide-url.
50+
[Edge Infrastructure Manager developer documentation][inframanager-dev-guide-url].
51+
52+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
53+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
54+
[os-profiles]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/shared/shared_os_profile.html

os-profiles/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.7-dev
1+
0.2.8-dev

tenant-controller/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ targets. The following is a list of makefile targets that support developer acti
9090
To learn more about internals and software architecture, see
9191
[Edge Infrastructure Manager developer documentation][inframanager-dev-guide-url].
9292

93-
[user-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html
94-
[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)
95-
[contributors-guide-url]: https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/index.html
93+
[user-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html
94+
[inframanager-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index.html
95+
[contributors-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html
9696
[inframanager-charts]: https://github.com/open-edge-platform/infra-charts

0 commit comments

Comments
 (0)