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.

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

Catalog docs #126

Merged
merged 9 commits into from
Jan 29, 2025
Merged

Catalog docs #126

merged 9 commits into from
Jan 29, 2025

Conversation

brian-intel
Copy link
Contributor

@brian-intel brian-intel commented Jan 27, 2025

PR Checklist

Author Mandatory (to be filled by PR Author/Submitter)

CODE MAINTAINABILITY

  • Commit Message meets guidelines as indicated in the URL*
  • Tests for the changes have been added (required for bug fixes / features). If not, state why not
  • Added labels (these are git labels such as bug or enhancement)
  • For any API changes or service changes, updates to the documentation were made (Swagger APIs & GitHub Docs). If not, state why not
  • Every commit is a single defect fix and does not mix feature addition or changes*

What are the steps to test this PR contribution?

How does a reviewer know it works?

Are there any special instructions beyond standard workflow?

Maintainer Mandatory (to be filled by PR Reviewer/Approving Maintainer)

QUALITY CHECKS

  • Quality of code (At least one should be checked as applicable)*
    • Commit Message meets guidelines
    • Code copyright is correct
    • PR changes adhere to industry practices and standards as well as domain or language specific anti-patterns
    • Adopted domain specific coding standards (Go Coding Standards)
    • Code is adequately commented and documented
    • Confusing logic is explained in comments
    • Error and exception code paths implemented correctly
    • Tracing output are minimized and logic
  • Test coverage shows adequate coverage with required CI functional tests pass on all supported platforms*
  • Static code scan report shows zero critical issues*

Other information

@brian-intel brian-intel requested a review from a team as a code owner January 27, 2025 18:27
@brian-intel brian-intel added the documentation Improvements or additions to documentation label Jan 27, 2025
antoniomtz
antoniomtz previously approved these changes Jan 28, 2025
Copy link
Contributor

@antoniomtz antoniomtz left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@ejlee3 ejlee3 left a comment

Choose a reason for hiding this comment

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

LGTM

@brian-intel brian-intel merged commit a1d490d into intel:main Jan 29, 2025
5 of 7 checks passed
@brian-intel brian-intel deleted the catalogDocs branch January 29, 2025 16:47
Copy link
Contributor

@NeethuES-intel NeethuES-intel left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants