Skip to content

[DOCS] Add new documentation checks to align with other OEP repositories#691

Merged
kblaszczak-intel merged 7 commits intoopen-edge-platform:mainfrom
sgolebiewski-intel:add-documentation-checks-for-main
Apr 2, 2026
Merged

[DOCS] Add new documentation checks to align with other OEP repositories#691
kblaszczak-intel merged 7 commits intoopen-edge-platform:mainfrom
sgolebiewski-intel:add-documentation-checks-for-main

Conversation

@sgolebiewski-intel
Copy link
Copy Markdown
Contributor

@sgolebiewski-intel sgolebiewski-intel commented Mar 12, 2026

Description

Add new documentation checks to GH to align with other repositiories in Open Edge Platform.

Fixes # (issue)

Any Newly Introduced Dependencies

Please describe any newly introduced 3rd party dependencies in this change. List their name, license information and how they are used in the project.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Checklist:

  • I agree to use the MIT license for my code changes.
  • I have not introduced any 3rd party components incompatible with MIT.
  • I have not included any company confidential information, trade secret, password or security token.
  • I have performed a self-review of my code.

Comment thread .github/workflows/documentation-check.yaml Fixed
@sgolebiewski-intel sgolebiewski-intel force-pushed the add-documentation-checks-for-main branch 2 times, most recently from d02fdc9 to b005d76 Compare March 12, 2026 14:31
@sgolebiewski-intel sgolebiewski-intel requested a review from a team as a code owner March 12, 2026 14:34
@sgolebiewski-intel sgolebiewski-intel force-pushed the add-documentation-checks-for-main branch 3 times, most recently from f6a5eb1 to ff4949c Compare March 13, 2026 06:53
@kblaszczak-intel kblaszczak-intel marked this pull request as draft March 13, 2026 09:30
@sgolebiewski-intel sgolebiewski-intel force-pushed the add-documentation-checks-for-main branch 2 times, most recently from edd6dd4 to 68b9d76 Compare March 24, 2026 12:30
@sgolebiewski-intel sgolebiewski-intel marked this pull request as ready for review March 24, 2026 12:30
Copy link
Copy Markdown
Contributor

@oonyshch oonyshch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall the approach looks good, please consider comments.

Comment thread .github/workflows/docs-reusable-workflow.yaml Outdated
Comment thread .github/workflows/docs-reusable-workflow.yaml Outdated
Comment thread docs/user-guide/index.md Outdated
Comment thread docs/user-guide/index.md Outdated
Copy link
Copy Markdown
Contributor

@nszczygl9 nszczygl9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to separate documentation workflows into 2 files?
I think we can have one documentation-check.yaml and just add steps from docs-reusable-workflow.yaml in build-dlstreamer-documentation job.

Comment thread .github/workflows/documentation-check.yaml Outdated
Comment thread .github/workflows/documentation-check.yaml Outdated
@nszczygl9
Copy link
Copy Markdown
Contributor

what about it?

sgolebiewski-intel and others added 4 commits April 2, 2026 10:12
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Co-authored-by: Olena (Lena) Onyshchenko <olena.onyshchenko@intel.com>
@sgolebiewski-intel sgolebiewski-intel force-pushed the add-documentation-checks-for-main branch from 3039f8d to 8630d52 Compare April 2, 2026 08:12
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Comment thread .github/workflows/documentation-check.yaml Outdated
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
@kblaszczak-intel kblaszczak-intel merged commit bc6c4ae into open-edge-platform:main Apr 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants