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

tutorial: add info about app bundle size limit #783

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Conversation

mike-sul
Copy link
Contributor

@mike-sul mike-sul commented Jan 15, 2025

Update the tutorial on Compose Apps with an info about the limit on size of the compose app bundle (effectively the app directory).

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

Why merge this PR? What does it solve?

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.

Copy link
Member

@vanmaegima vanmaegima left a comment

Choose a reason for hiding this comment

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

LGTM

@mike-sul mike-sul requested a review from kprosise January 15, 2025 17:44
Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

Just one minor suggestion, otherwise it LGTM.

Update the tutorial on Compose Apps with an info about the limit on
size of the compose app bundle (effectively the app directory).

Signed-off-by: Mike Sul <mike.sul@foundries.io>
@mike-sul mike-sul force-pushed the app-bundle-size-limit branch from a4f756c to 49af5d4 Compare January 16, 2025 13:50
@mike-sul
Copy link
Contributor Author

@vanmaegima @caiotpereira @mike-scott @kprosise I've deployed the change mentioned in this doc update, hence we can merge it (The question is how to update the user doc without LmP release).

@vanmaegima
Copy link
Member

@mike-sul This change can wait until the next LmP release, and if necessary we in CS can point the customer to this information for now, wdyt?

@mike-sul
Copy link
Contributor Author

@mike-sul This change can wait until the next LmP release, and if necessary we in CS can point the customer to this information for now, wdyt?

But, releases/changes of the backend components are not bound to LmP releases.

@kprosise
Copy link
Contributor

@mike-sul We could always do a re-release of the docs if desired.

@kprosise kprosise merged commit 7a9f154 into main Jan 22, 2025
2 of 3 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.

3 participants