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

docs for new git persistence mode #222

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

Conversation

jrvidal
Copy link
Contributor

@jrvidal jrvidal commented Jun 26, 2024

Summary of changes

Docs for the new git persistence mode.

Copy link

stackblitz bot commented Jun 26, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for stackblitz-docs ready!

Name Link
🔨 Latest commit e14ec20
🔍 Latest deploy log https://app.netlify.com/sites/stackblitz-docs/deploys/667bdedc99887800083aef60
😎 Deploy Preview https://deploy-preview-222--stackblitz-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@kirjavascript kirjavascript left a comment

Choose a reason for hiding this comment

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

Did a few passes, and this reads really well.

Feel free to ignore the comments and merge, they're either pedantic or unimportant.


# {{ $frontmatter.title }}

The StackBlitz editor has some differences with respect to _persistence_ (whether and how we store your changes) between _projects_ and Git repositories.
Copy link
Member

Choose a reason for hiding this comment

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

Seems inconsistent to italicise projects, but not Git repositories


In its default mode, the StackBlitz editor **does _not_ store your changes** when you open a Git repository (for instance, https://stackblitz.com/~/github.com/vitejs/vite). You can edit files, create new commits and push them to a remote. However, any intermediate changes that are not pushed will be lost after reloading the page. The editor shows a prominent warning to remind you when persistence is off.

This is in constrast with _projects_, which always keep your changes stored in the StackBlitz backend. The rough rationale for this difference in behavior is that, for Git-based projects, the ultimate goal is to push some new changes into a remote that already exists. This remote ultimately acts as your storage.
Copy link
Member

Choose a reason for hiding this comment

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

repeated use of ultimate. either one could be dropped and the sentence would still work

Comment on lines +21 to +23
* You should be logged in, and
* You should have push permissions for the repository, and
* You should not be working on the default branch.
Copy link
Member

Choose a reason for hiding this comment

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

, and feels superfluous in a list like this

Comment on lines +49 to +50
* Discard your old changes and start working fresh again from the latest commit.
* Push your ongoing changes to an intermediate branch and create a pull request.
Copy link
Member

Choose a reason for hiding this comment

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

if the convention from the previous list was followed, should the first item here end with , or?

I suppose the previous , and helps disambiguate here

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