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 lost container preloading info #701

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

kprosise
Copy link
Contributor

Information that was on the removed
reference-manual/linux/preloaded-images page that did not migrate to the user-guide page was added.

QA: visually inspected html, checked with linter. No issues spotted.

No associated Ticket/Issue, as this was a quick fix.

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

Focus was mostly upon copying the old information and cleaning it up. Open to suggestions if context or content needs additional work. Redirect was also added.

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

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

Information that was on the removed
`reference-manual/linux/preloaded-images` page that did not migrate to
the user-guide page was added.

QA: visually inspected html, checked with linter. No issues spotted.

No associated Ticket/Issue, as this was a quick fix.

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise requested review from mwasilew, vanmaegima, mike-sul and a team April 16, 2024 12:35
@doanac
Copy link
Member

doanac commented Apr 16, 2024

@mwasilew
Copy link
Contributor

LGTM

Copy link
Contributor

@mike-sul mike-sul left a comment

Choose a reason for hiding this comment

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

Thanks!

More complex workflows are common.
For example, a Factory may have ``containers.git`` set up with multiple branches where each specifies a different set of apps.

Assume you have four branches with the following application:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I assume the 4 branches are: devel, experimental, main, production

it took me 3 seconds to understand "money-making-app" is not the branch name

I'm only saying, I don't know if anything should be changed.

@kprosise kprosise merged commit def4a7e into foundriesio:main Apr 19, 2024
2 of 3 checks passed
@kprosise kprosise deleted the add-advanced-preloading-info branch April 19, 2024 10:45
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.

7 participants