Skip to content

Commit c5d2646

Browse files
Merge branch 'main' into GHI-1891
2 parents 376c977 + a1df2df commit c5d2646

File tree

12 files changed

+752
-333
lines changed

12 files changed

+752
-333
lines changed

.github/workflows/docs-reusable-workflow.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# SPDX-FileCopyrightText: (C) 2025 Intel Corporation
33
# SPDX-License-Identifier: Apache-2.0
44

5-
name: 'Build Documentation'
5+
name: "Build Documentation"
66

7-
on: # yamllint disable-line rule:truthy rule:line-length
7+
on: # yamllint disable-line rule:truthy rule:line-length
88
workflow_call:
99
inputs:
1010
docs_directory:
@@ -33,14 +33,13 @@ permissions:
3333
jobs:
3434
build-documentation:
3535
permissions:
36-
contents: read # minimal privilege required
36+
contents: read # minimal privilege required
3737
runs-on: ubuntu-latest
3838
env:
3939
DOCS_DIR: ${{ inputs.docs_directory }}
4040
steps:
41-
4241
- name: Checkout code
43-
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
42+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
4443
with:
4544
# Fetch all history, otherwise sporadic issue with missing tags
4645
fetch-depth: 0

.github/workflows/documentation-check.yaml

Lines changed: 132 additions & 104 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

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

22
# Edge-AI-Suites Contributor Guide
33

4-
The following are guidelines for contributing to the Edge AI Suites project, including the code of conduct, submitting issues, and contributing code.
4+
The following are guidelines for contributing to the Edge AI Suites project, including the code of conduct, submitting issues, and contributing code.
55

66
# Table of Contents
77

@@ -15,37 +15,44 @@ The following are guidelines for contributing to the Edge AI Suites project, inc
1515

1616
# Code of Conduct
1717

18-
This project and everyone participating in it are governed by the [`CODE_OF_CONDUCT`](CODE_OF_CONDUCT.md) document. By participating, you are expected to adhere to this code.
18+
This project and everyone participating in it are governed by the [`CODE_OF_CONDUCT`](CODE_OF_CONDUCT.md) document. By participating, you are expected to adhere to this code.
1919

20-
# Security
20+
# Security
2121

22-
Read the [`Security Policy`](SECURITY.md).
22+
Read the [`Security Policy`](SECURITY.md).
2323

2424
# Get Started
2525

26-
Clone the repository and follow the [`README`](README.md) to get started with the sample applications of interest.
26+
Clone the repository and follow the [`README`](README.md) or
27+
[documentation's](https://docs.openedgeplatform.intel.com/) "Get Started" of the chosen
28+
applications.
2729

2830
```
2931
git clone https://github.com/open-edge-platform/edge-ai-suites.git
3032
cd edge-ai-suites
3133
```
34+
Note that you do not need to clone the entire repository. You can clone just the portion you
35+
are interested with. To see how ti do it, check out the
36+
[Contributing to Open Edge Platform](https://docs.openedgeplatform.intel.com/canonical/OEP-articles/contribution-guide.html#repository-cloning-partial-cloning)
37+
article.
38+
3239

3340
# How to Contribute
3441

3542
## Contribute Code Changes
3643

37-
> If you want to help improve Edge AI Suites, choose one of the issues reported in [`GitHub Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues) and create a [`Pull Request`](https://github.com/open-edge-platform/edge-ai-suites/pulls) to address it.
44+
> If you want to help improve Edge AI Suites, choose one of the issues reported in [`GitHub Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues) and create a [`Pull Request`](https://github.com/open-edge-platform/edge-ai-suites/pulls) to address it.
3845
> Note: Please check that the change hasn't been implemented before you start working on it.
3946
4047
## Improve Documentation
4148

4249
The easiest way to help with the `Developer Guide` and `User Guide` is to review it and provide feedback on the
43-
existing articles. Whether you notice a mistake, see the possibility of improving the text, or think more
50+
existing articles. Whether you notice a mistake, see the possibility of improving the text, or think more
4451
information should be added, you can reach out to discuss the potential changes.
4552

4653
## Report Bugs
4754

48-
If you encounter a bug, open an issue in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues). Provide the following information to help us
55+
If you encounter a bug, open an issue in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues). Provide the following information to help us
4956
understand and resolve the issue quickly:
5057

5158
- A clear and descriptive title
@@ -59,7 +66,7 @@ understand and resolve the issue quickly:
5966

6067
Intel welcomes suggestions for new features and improvements. Follow these steps to make a suggestion:
6168

62-
- Check if there's already a similar suggestion in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues).
69+
- Check if there's already a similar suggestion in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues).
6370
- If not, open a new issue and provide the following information:
6471
- A clear and descriptive title
6572
- A detailed description of the enhancement
@@ -75,7 +82,7 @@ Before submitting a pull request, ensure you follow these guidelines:
7582
- Test your changes thoroughly.
7683
- Document your changes (in code, readme, etc.).
7784
- Submit your pull request, detailing the changes and linking to any relevant issues.
78-
- Wait for a review. Intel will review your pull request as soon as possible and provide you with feedback.
85+
- Wait for a review. Intel will review your pull request as soon as possible and provide you with feedback.
7986
You can expect a merge once your changes are validated with automatic tests and approved by maintainers.
8087

8188
# Development Guidelines
@@ -95,7 +102,7 @@ Clear and informative commit messages make it easier to understand the history o
95102
- Capitalize the first letter
96103
- Keep the message concise, ideally under 50 characters
97104

98-
Please fill in the details as per the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) while submitting the
105+
Please fill in the details as per the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) while submitting the
99106
pull request.
100107

101108
## Testing

0 commit comments

Comments
 (0)