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

Add oe_builtin app note #799

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kprosise
Copy link
Contributor

Added to an existing admonition, and changed admonition type from "note" to "important".

QA: Checked rendered output, no issues found.

This commit addresses FFTK-1660, "…OE Apps must be validated…"

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Older issue, but appears to still be applicable.

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Kept message terse, and isn't something which would apply for most folks.

Added to an existing admonition, and changed admonition type from "note"
to "important".

QA: Checked rendered output, no issues found.

This commit addresses FFTK-1660, "…OE Apps must be validated…"

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested review from vanmaegima, mike-sul and a team February 12, 2025 16:17
@@ -70,6 +70,8 @@ making sure to set the appropriate values for ``app_type`` and ``oe_builtin`` (s

This option does not work with some advanced tagging cases, e.g. multiple container builds using the same platform (see :ref:`ref-advanced-tagging` for more details).

**The Apps must be validated and without conflict**.
Copy link
Member

Choose a reason for hiding this comment

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

@kprosise can you clarify what this means?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can try, though there isn't much more info recorded anywhere, but I will check with the Platform team.

Copy link
Member

Choose a reason for hiding this comment

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

I mean, I didn't understand what this means exactly, maybe it means that the apps and platform need to be aligned and verified before enabling container preloading?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this use-case is meant by This option does not work with some advanced tagging cases, e.g. multiple container builds using the same platform.

The OE builtin app preloading fails in such the case because there is an ambiguity in terms of which of the tags' apps to choose. For example, in the example provided in the doc the dilemma is: should be the apps of the main branch preloaded or the foo branch of the containers.git repo?

Copy link
Member

Choose a reason for hiding this comment

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

I understand that, but not sure what "The Apps must be validated and without conflict" means in this context. Maybe we just remove this line as it's causing confusion?

Copy link
Contributor

Choose a reason for hiding this comment

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

@kprosise
Probably we just remove that phrase or replace it with something what I wrote above "The OE builtin app preloading fails in such the case because there is an ambiguity in terms of which of the tags' apps to choose..."?

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.

3 participants