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

Minor docs issues #332

Merged
merged 3 commits into from
May 21, 2024
Merged

Minor docs issues #332

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
7de0296
Fix Drops contribution guidelines
fcabreramsft May 21, 2024
3a46351
Add space between words
fcabreramsft May 21, 2024
40e4e1c
Fix extra /
fcabreramsft May 21, 2024
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
2 changes: 1 addition & 1 deletion docs/azure_jumpstart_ag/manufacturing/contoso_motors/ai_inferencing/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

# Web UI and AI Inference

Contoso Motors leverages AI-powered manufacturing with a Kubernetes-based infrastructure which provides a flexible and scalable design that can be easily extended. This document covers how Contoso Motors implements different AI inferencing models for various use cases, leveraging [OpenVINO™ Model Server (OVMS)](https://docs.openvino.ai/2023.3/ovms_what_is_openvino_model_server.html). The OVMS by Intel, is a high-performance inference serving software that allows users to deploy and serve multiple AI models in a convenient, scalable and efficient manner.

Check failure on line 19 in docs/azure_jumpstart_ag/manufacturing/contoso_motors/ai_inferencing/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'inferencing'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'inferencing'?", "location": {"path": "docs/azure_jumpstart_ag/manufacturing/contoso_motors/ai_inferencing/_index.md", "range": {"start": {"line": 19, "column": 229}}}, "severity": "ERROR"}

## Architecture

Expand Down Expand Up @@ -56,7 +56,7 @@

The AI inference server, in our case the [OpenVINO™ Model Server](https://docs.openvino.ai/2023.3/ovms_what_is_openvino_model_server.html), hosts models and makes them accessible to software components over standard network protocols: a client sends a request to the model server, which performs model inference and sends a response back to the client.

The OVMS model server is configured as part of the helm deployment, using the **OVMS Operator**. The deployment installs the OVMS Operator, sets up the storage for AI models, and configures the OVMS pods and services. For more information about the setup, check [OVMS Helm](https://github.com/microsoft/jumpstart-agora-apps/tree/manufacturing/contoso_manufacturing/operations/charts/ovms).For more information about OVMS Operator, check [OpenVINO™ Model Server with Kubernetes](https://docs.openvino.ai/archive/2021.4/ovms_docs_kubernetes.html). The OVMS model server is typically deployed as a set of pods. Each pod contains one or more instances of the OVMS software, along with any necessary dependencies. The pods are managed by a Kubernetes controller, which is responsible for ensuring that the desired number of pods are running at all times.
The OVMS model server is configured as part of the helm deployment, using the **OVMS Operator**. The deployment installs the OVMS Operator, sets up the storage for AI models, and configures the OVMS pods and services. For more information about the setup, check [OVMS Helm](https://github.com/microsoft/jumpstart-agora-apps/tree/manufacturing/contoso_manufacturing/operations/charts/ovms). For more information about OVMS Operator, check [OpenVINO™ Model Server with Kubernetes](https://docs.openvino.ai/archive/2021.4/ovms_docs_kubernetes.html). The OVMS model server is typically deployed as a set of pods. Each pod contains one or more instances of the OVMS software, along with any necessary dependencies. The pods are managed by a Kubernetes controller, which is responsible for ensuring that the desired number of pods are running at all times.

2. **Post-process and UI rendering:** this is the code in the **Web AI Inference and UI** pod is responsible for handling post-processing and final UI rendering for the user. Depending on the model, once the OVMS provides the inference response, post-processing is applied to the image, such as adding labels, bounding boxes, or human skeleton graphs. Once the visual data is added to the frame, it's then served to the UI frontend using a **Flask App** method. For more information on the Flask App, please refer to the [Web UI - app.py](https://github.com/microsoft/jumpstart-agora-apps/blob/main/contoso_manufacturing/developer/webapp-decode/app.py)

Expand Down
8 changes: 4 additions & 4 deletions docs/drops_contribution_guidelines/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ The contribution process consists of the following steps:

- **Source Code**: Include all the code files you've created, along with any necessary documentation (README, images, videos, etc.). Ensure these files follow the correct structure defined in the [folder structure](#folder-structure) section.

- **Drop Definition**: Provide a JSON file with all the required fields as described in the [Drops Schema](./SCHEMA.md) definition. This file will be used by the Arc Jumpstart Drops page to create a Drop card with all the necessary information, as you can see in the following image.
- **Drop Definition**: Provide a JSON file with all the required fields as described in the [Drops Schema](https://github.com/Azure/arc_jumpstart_drops/blob/main/SCHEMA.md) definition. This file will be used by the Arc Jumpstart Drops page to create a Drop card with all the necessary information, as you can see in the following image.

![Drop card](./drop_definition.png)

1. Drop card created for each *JSON* definition schema file placed under the [drops](./drops/) folder, with a unique *Title* and *Authors*. The name should be unique, have a proper description, and use **snake_case**.
1. Drop card created for each *JSON* definition schema file placed under the [drops](https://github.com/Azure/arc_jumpstart_drops/tree/main/drops) folder, with a unique *Title* and *Authors*. The name should be unique, have a proper description, and use **snake_case**.
1. Description of the Drop
1. Filter bar to filter Drops based on the metadata of the Drop, like tags, products, creation date, and topics.
1. Tags and action buttons: _Download_ and _Share_.
Expand All @@ -62,11 +62,11 @@ The contribution process consists of the following steps:

1. **Merge to Canary**: If everything is correct, the PR will be merged to the **canary** branch, and the new Drop will be part of the approved Drops curated list.

1. **Validation with Preview Site**: Validate the changes using the [Preview Azure Arc Jumpstart site](https://preview.arcjumpstart.com/arc_jumpstart_drops). Ensure to check that your Drop is rendering correctly. Take some time to review the Drop card, and once finished, review the right-sidebar with all the context from your _README.md_ or _Index.md_.
1. **Validation with Preview Site**: Validate the changes using the [Preview Azure Arc Jumpstart site](https://preview.arcjumpstart.com/azure_jumpstart_drops). Ensure to check that your Drop is rendering correctly. Take some time to review the Drop card, and once finished, review the right-sidebar with all the context from your _README.md_ or _Index.md_.

![Preview site](./preview_site.png)

1. **Merge to Main**: Finally, once the **Canary** branch is merged to **Main** and published to Production, the Drop will be available as part of [Azure Arc Jumpstart Drops](https://arcjumpstart.com/arc_jumpstart_drops).
1. **Merge to Main**: Finally, once the **Canary** branch is merged to **Main** and published to Production, the Drop will be available as part of [Azure Arc Jumpstart Drops](https://arcjumpstart.com/azure_jumpstart_drops).

## Drop Index

Expand Down
2 changes: 1 addition & 1 deletion docs/mission/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

## Our mission and principles: Empowering seamless Azure Arc adoption

Welcome to the heart of our mission at Azure Arc Jumpstart, where we strive to transform your learning experience into a smooth and empowering journey. Our commitment is rooted in the principles that drive us forward:

Check failure on line 10 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'US' instead of 'us'.

Raw Output:
{"message": "[Vale.Terms] Use 'US' instead of 'us'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 10, "column": 207}}}, "severity": "ERROR"}

1. **Enabling immediate engagement:** Arc Jumpstart is designed to offer a seamless "zero to hero" experience. We understand the value of your time, and our goal is to enable you to dive right into Azure Arc, eliminating barriers and complexities.

2. **Comprehensive guidance:** We provide more than just guides; we offer comprehensive, step-by-step instructions tailored for various independent Azure Arc scenarios. Our content is meticulously detailed, incorporating extensive automation, vivid screenshots, and insightful code samples. This ensures that your learning journey is not just informative but also visually enriching and deeply engaging.

Check failure on line 14 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 14, "column": 332}}}, "severity": "ERROR"}

3. **Unparalleled user experience:** Our dedication lies in delivering a rich and immersive experience. We go beyond the basics, curating a user-centric environment that resonates with both beginners and seasoned professionals. Whether you're setting up your environment on-premises or in the cloud, our guides empower you to focus on Azure Arc's core values without being bogged down by technical intricacies.

Expand All @@ -31,19 +31,19 @@

4. **Inclusivity in deployment:** We support as many deployment options as possible, recognizing the diversity of your environment. Regardless of your infrastructure, our guides are tailored to ensure seamless integration, making Azure Arc accessible to everyone.

5. **Attention to detail:** No detail is too small for us. We try to include every necessary screenshot, note, disclaimer, and explanation.

Check failure on line 34 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'US' instead of 'us'.

Raw Output:
{"message": "[Vale.Terms] Use 'US' instead of 'us'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 34, "column": 56}}}, "severity": "ERROR"}

6. **Embracing innovation:** We focus exclusively on public preview and General Availability (GA) services/features, ensuring that you have access to the latest innovations and capabilities, enabling you to stay ahead in your journey with Azure Arc.

![Image of the Jumpstart core design principles](/img/about/principles.png)

## Our commitment to the open source community: elevating excellence together

Check failure on line 40 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Microsoft.HeadingColons] Capitalize ': e'.

Raw Output:
{"message": "[Microsoft.HeadingColons] Capitalize ': e'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 40, "column": 47}}}, "severity": "ERROR"}

At Arc Jumpstart, we consider high code quality not just a priority, but a fundamental principle. Our extensive automation and scripting for scenarios and features undergo rigorous code reviews and testing, ensuring a standard of excellence that our users can rely on. We believe that quality is not just about meticulous craftsmanship, but also about selecting and integrating the right tools effectively.

Check failure on line 42 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 42, "column": 294}}}, "severity": "ERROR"}

In the spirit of open source collaboration, we are deeply committed to supporting the wider community. We recognize the remarkable contributions of others and actively seek opportunities to build upon their work. With over 30 open source projects integrated into Jumpstart, our commitment extends beyond mere usage. We pledge to support, advocate, and contribute to these projects, fostering an environment of mutual growth and innovation.

Check failure on line 44 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we're' instead of 'we are'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'we're' instead of 'we are'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 44, "column": 45}}}, "severity": "ERROR"}

By embracing this ethos, we are dedicated to providing you with an unparalleled open source experience. Together, let's elevate the standards of open source excellence and create a vibrant community where innovation knows no bounds.

Check failure on line 46 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we're' instead of 'we are'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'we're' instead of 'we are'.", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 46, "column": 26}}}, "severity": "ERROR"}

![Image showing open source projects logos](/img/about/oss.png)

Expand All @@ -63,7 +63,7 @@

- **Visual learning:** Visual cues enhance comprehension. Detailed screenshots provide visual context, enhancing your learning experience and making complex topics more accessible.

> **Disclaimer:** Azure Arc Jumpstart focuses on core Azure Arc capabilities, deployment scenarios, and practical use-cases. While we provide extensive support, please note that Azure best-practices and the integration of various technologies and open source projects within the scenarios and code are outside our primary scope. The scenarios, including ArcBox, HCIBox, and Agora, are designed for evaluation, training, and demo purposes exclusively and are not intended for production use cases.

Check failure on line 66 in docs/mission/_index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'HCIBox'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'HCIBox'?", "location": {"path": "docs/mission/_index.md", "range": {"start": {"line": 66, "column": 363}}}, "severity": "ERROR"}

## Jumpstart public roadmap

Expand All @@ -71,4 +71,4 @@

## Want to be an Arc "Jumpstarter"?

We would love to have you and are always looking for community contribution! Hop over to the [Jumpstart contribution guidelines](/contribution_guidelines/) and get started.
We would love to have you and are always looking for community contribution! Hop over to the [Jumpstart contribution guidelines](/contribution_guidelines) and get started.
Loading