Skip to content

readme + get started link improvements #108

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

Merged
merged 4 commits into from
May 21, 2025
Merged

readme + get started link improvements #108

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99c39fc
readme + get started link improvements
mpytlik-intel May 20, 2025
8161bd5
Update docs/developer-guide/get-started.md
kblaszczak-intel May 20, 2025
d18659b
Update README.md
kblaszczak-intel May 21, 2025
9e682af
Merge branch '3.0' into readme-cleanup
anujm1 May 21, 2025
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
41 changes: 21 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ the existing infrastructure.

The currently published versions are:

* [Edge Microvisor Toolkit Standalone (immutable)](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge-microvisor-toolkit-standalone-node)
* [Edge Microvisor Toolkit Developer (mutable)](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge--microvisor-toolkit-development-node)
* Edge Microvisor Toolkit (immutable)
* Edge Microvisor Toolkit with real time extensions (immutable)
* Edge Microvisor Toolkit Standalone (immutable) ([Download link](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge-microvisor-toolkit-standalone-node))
* Edge Microvisor Toolkit Developer (mutable) ([Download link](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge--microvisor-toolkit-development-node))

The Edge Microvisor Toolkit has undergone extensive validation across all Intel
platforms such as Xeon®, Intel® Core Ultra™, Intel Core™ and Intel® Atom®. It
Expand All @@ -30,24 +30,25 @@ Toolkit are available as Open-Source.

## Get Started

Check out these articles to quickly learn how to work with Edge Microvisor Toolkit:

* [System requirements](./docs/developer-guide/system-requirements.md)
for the hardware and software requirements.
* [Download](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge--microvisor-toolkit-development-node) and [install the developer ISO image](./docs/developer-guide/get-started.md#edge-microvisor-toolkit-developer)
for a mutable container host providing only minimum functionality.
* [Download](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge-microvisor-toolkit-standalone-node) and [install the production RAW image]( ./docs/developer-guide/get-started.md#edge-microvisor-toolkit-standalone)
for an immutable container host with essential functionality.
* [Install on bare metal edge node](./docs/developer-guide/get-started/installation-howto.md#baremetal-with-iso) or
[Install on a Virtual Machine](./docs/developer-guide/get-started/installation-howto.md#virtual-machine-with-hyper-v)
to learn how to install Edge Microvisor Toolkit.
* [Build or customize the Edge Microvisor](./docs/developer-guide/get-started/building-howto.md)
for maximum control over the system you want to deploy.
* [Edge Manageability Framework integration](./docs/developer-guide/deployment-edge-orchestrator.md)
for scalable, secure, reliable, and automated management of edge infrastructure.
* [Understand the security features of the Edge Microvisor](./docs/developer-guide/security.md)
to ensure security for workloads and data.
* [Troubleshooting](./docs/developer-guide/troubleshooting.md) provides you answers to commonly asked questions.
Check out these articles to quickly learn how to work with Edge Microvisor Toolkit.

**EMT Developer Toolkit**:

* [Downloading and installing the developer tookit ISO image](./docs/developer-guide/get-started.md#edge-microvisor-toolkit-developer).
* [Building a custom Edge Microvisor Toolkit image](./docs/developer-guide/get-started/building-howto.md)

**EMT Standalone Toolkit**

* [Downloading and installing the standalone toolkit RAW image]( ./docs/developer-guide/get-started.md#edge-microvisor-toolkit-standalone).

**Common**

* [Hardware and software system requirements](./docs/developer-guide/system-requirements.md)
* [Installing EMT on bare metal edge node](./docs/developer-guide/get-started/installation-howto.md#bare-metal-with-iso)
* [Installing EMT on a Virtual Machine](./docs/developer-guide/get-started/installation-howto.md#virtual-machine-with-hyper-v)
* [Integrating the Edge Manageability Framework](./docs/developer-guide/deployment-edge-orchestrator.md)
* [Using the security features of the Edge Microvisor](./docs/developer-guide/security.md)
* [Troubleshooting common issues](./docs/developer-guide/troubleshooting.md)

## Getting Help

Expand Down
11 changes: 5 additions & 6 deletions docs/developer-guide/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This section provides an overview of both the operating system and build
pipelines. Once you have decided on the usage scenarios presented below, you can
move on to:

- [Build an Edge Microvisor Toolkit Image.](./get-started/building-howto.md)
- [Install Edge Microvisor Toolkit.](./get-started/installation-howto.md)
- [Build a new Edge Microvisor Toolkit Image.](./get-started/building-howto.md)
- [Install Edge Microvisor Toolkit from existing image.](./get-started/installation-howto.md)

## Usage Scenarios

Expand All @@ -25,8 +25,8 @@ applications.

To create a custom developer build of Edge Microvisor Toolkit, follow these steps:

- Download the mutable host ISO image from
[Intel® Edge Software Catalog](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipe&microserviceNameForUrl=edge--microvisor-toolkit-development-node).
- [Download the mutable host ISO image](https://files-rs.edgeorchestration.intel.com/files-edge-orch/microvisor/iso/EdgeMicrovisorToolkit-3.0.iso) from
Intel® Edge Software Catalog.
- Install the mutable host via ISO image that includes only essential pre-installed packages,
providing a ready-to-use base environment.
- Install additional RPM packages, using DNF to tailor the OS to your specific needs.
Expand Down Expand Up @@ -55,8 +55,7 @@ monitoring tools, standard cloud-edge (CNCF) software, and more.

### Edge Microvisor Toolkit Standalone

The ISO installer for the standalone Edge Node is available for download at
[Intel® Edge Software Catalog](https://edgesoftwarecatalog.intel.com/package/edge_microvisor_toolkit_standalone_node).
[Download the ISO installer](https://edgesoftwarecatalog.intel.com/package/licenseagreement/edge_microvisor_toolkit_standalone_node) for the standalone Edge Node from the Intel® Edge Software Catalog.

The standalone edge node uses the standard immutable build and provides an ISO
image that can be flashed to a USB device and installed on edge nodes. It
Expand Down