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

Modified readme to recommend installing recipes in a scratch org (as opposed to sandbox) #108

Merged
merged 2 commits into from
Aug 16, 2021

Conversation

solo-1234
Copy link
Contributor

No description provided.

@solo-1234
Copy link
Contributor Author

Not sure if I did this correctly, any feedback is welcome.

@tsalb
Copy link
Owner

tsalb commented Aug 13, 2021

Almost there! You can actually pull the wiki files too, though I am not 100% sure if you can include them in the same PR (that's your homework)

I'd like to see all following changes in the wiki as well, for example:

https://github.com/tsalb/lwc-utils/wiki/Installation

So, one (or two) action items:

  • Amend this PR to include wiki edits
  • Create a second PR which includes wiki edits, add comment (to either this or new PR) linking both

Then, I will double check the PR and make sure we address these verbiage changes simultaneously.

@solo-1234
Copy link
Contributor Author

It appears that wiki edits cannot be included in a PR...
https://github.community/t/how-to-fork-a-wiki-and-send-a-pr/2006

@tsalb
Copy link
Owner

tsalb commented Aug 16, 2021

That is unfortunate, as a workaround maybe we can do this:

Can you please comb through the wiki and let me know if there are any other references to “sandbox” and we can change that verbiage to “scratch org”.

I’m looking for a bullet list of both pages and content that will have to change. Basically, the format should be easy enough for me to execute since we can’t do it in a PR sadly…

@solo-1234
Copy link
Contributor Author

Do you want to change all to scratch org, or add that scratch orgs are recommended over sandboxes?

In some places I'd keep sandbox (like the installation links...)

@tsalb
Copy link
Owner

tsalb commented Aug 16, 2021

Everything should be scratch org, all references sandboxes are deprecated as of this PR to avoid potential issues.

The developer using this lib should know how to spin up scratch orgs.

FWIW, I never used sandboxes to test the recipes. This PR will make the signaling very clear that scratch orgs are the way to go (alignment to lwc-recipes from Salesforce themselves).

@solo-1234
Copy link
Contributor Author

Right but for installing core, I'd do it in a sandbox first to test things before installing it in prod

@tsalb
Copy link
Owner

tsalb commented Aug 16, 2021

Yea, but that is not my problem ;)

That’s up to the developer on how to install - this repo no longer recommends the action forward for you.

@solo-1234
Copy link
Contributor Author

solo-1234 commented Aug 16, 2021

For sure - but I'd keep the core sandbox install link for that purpose, personally.

@tsalb
Copy link
Owner

tsalb commented Aug 16, 2021

The intention here is to make it a little harder to install on a sandbox so only users who know what to do with the package ids know what to do with them.

Think of it like an intentional barrier to entry, one that is more targeted for devs.

As this is my preference, I will align to the instructions I have set up on my corporate version of this lib.

@solo-1234
Copy link
Contributor Author

Got it

@tsalb
Copy link
Owner

tsalb commented Aug 16, 2021

For the purposes of this PR, feel free to omit the content for the wiki as I have some ideas for it.

What I need from you to unblock this PR are a list of wiki pages (as a sanity check) on where we would need to make verbiage updates. The content of the change I will noodle on, but it’s good to link specific pages to this PR so we can trace for posterity.

@solo-1234
Copy link
Contributor Author

solo-1234 commented Aug 16, 2021

@tsalb tsalb self-requested a review August 16, 2021 19:07
@tsalb tsalb self-assigned this Aug 16, 2021
@tsalb tsalb added the chore Devil is in the detail label Aug 16, 2021
@tsalb tsalb merged commit b2b783a into tsalb:master Aug 16, 2021
@tsalb
Copy link
Owner

tsalb commented Aug 16, 2021

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Devil is in the detail
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants