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

feat: Version Control and Tagging (Packages) #2842

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

harshilp24
Copy link
Collaborator

Description

Provide a concise summary of the changes made in this pull request

Pull request type

Check the appropriate box:

  • Review Fixes
  • Documentation Overhaul
  • Feature/Story
    • Link one or more Engineering Tickets
      *
  • A-Force
  • Error in documentation
  • Maintenance

Documentation tickets

Link to one or more documentation tickets:

Checklist

From the below options, select the ones that are applicable:

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

Copy link

vercel bot commented Mar 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
appsmith-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 28, 2025 10:43am

@pedro-santos-rodrigues
Copy link

Would it make sense to review this sentence here since now we also have Cloud managed-hosting so self-hosted is not mandatory?
image

@pedro-santos-rodrigues
Copy link

pedro-santos-rodrigues commented Mar 22, 2025

I was going through the page where we explain the basics of Packages and Modules, and I was wondering if we shouldn't leave a small note when we have the publish step explained saying that this is going to make the changes available for consumption so that it mentions that if the package is git connected you also need to release a new version and have a link to the Version Control and Tagging documentation page
image

Other similar cases:
In the JS Modules page
image

In the following info box, consider if you want to clarify that the changes are applied immediately to edit mode if the app isn't git connected. It it's git connected it continues to use the previous version until is changed directly while editing the app.
image

Pass data between modules
image

@@ -145,6 +150,8 @@ With this, you can format dates using the JS module in multiple places throughou

:::info
When you update and publish a package, these modifications automatically apply in the edit mode of the app. However, the live (deployed) version of the app remains unchanged until you redeploy the app.

If the package is git-connected, it continues to use the previous version until it is changed directly while editing the app.

Choose a reason for hiding this comment

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

Suggestion: to make it more clear that the difference of git vs. non-git is only in edit mode and that deploy mode has the same behavior no matter the git connection exists or not, what if we change the order of the text to something like:

:::info
When you update and publish a package, these modifications automatically apply in the edit mode of the app. If the package is git-connected, it continues to use the previous version until it is changed directly. 
However, in both cases, the live (deployed) version of the app remains unchanged until you redeploy the app. 

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.

2 participants