Add documentation for migrate command #88
Conversation
docs/commands/index.md
Outdated
| slate migrate | ||
| ``` | ||
|
|
||
| Converts an existing theme to work with Slate. Run this command from your project root to install dependencies and your theme files moved to to a `src/` directory. Use [theme commands](#theme-commands) to start developing. An empty `styles/` and `scripts/` folder will also be created. |
There was a problem hiding this comment.
and your theme files moved to to a - 🔥 second to.
docs/index.md
Outdated
| @@ -18,7 +18,7 @@ Slate allows you to sync local files with your live shop, deploy to multiple env | |||
| * Not sure how to create a private app? [Learn how here](https://help.shopify.com/api/guides/api-credentials#get-credentials-through-the-shopify-admin). | |||
| * Set the "Theme templates and theme assets" permission to "Read and write". | |||
| <img src="{{ "/assets/images/app-permission.jpg" | prepend: site.baseurl }}" alt="Private app permission requirements" class="demo-image demo-image--app"> | |||
| 4. Rename `config-sample.yml` to `config.yml` and add your private app credentials: | |||
| 4. Rename `config-sample.yml` to `config.yml` and add your private app credentials. Use [this sample config file](https://github.com/Shopify/slate/blob/master/config-sample.yml) if you are using the migration tool. | |||
There was a problem hiding this comment.
I don't think this sentence is necessary. You're linking to the same config-sample.yml that is provided after completing step 2. And if they've already done step 2, it's too late to benefit from slate migrate.
This addition makes more sense at step 2.
- Create a new theme with
slate theme theme-name, wheretheme-namewill be a newly created folder. If you already have a theme locally, you can use theslate migratecommand instead.
^ I wouldn't use the wording "migration tool" as it sounds like a separate app - reference the command instead.
There was a problem hiding this comment.
Only problem here is that slate migrate will not generate a config-sample.yml for you. There's no other reference to that file so if you don't have it you're SOL.
How about:
- Rename
config-sample.ymltoconfig.ymland add your private app credentials. Use this sample config file if you prefer to manually create it.
There was a problem hiding this comment.
I still feel the migration command needs to be presented before someone types slate theme. What if in step 2 it links migrate command like in the example I gave and the migrate docs at docs/commands/index.md has the link and write-up you have for a sample config file?
|
Updated the copy a bit @NathanPJF. Info about config.yml is moved to the commands page under |
|
Looks good - I'll 🎩 Shopify/slate-cli#108 today so these can be merged at the same time |
docs/commands/index.md
Outdated
| slate migrate | ||
| ``` | ||
|
|
||
| Converts an existing theme to work with Slate. Run this command from your project root to install dependencies and restructure your theme files into a `src/` directory. Empty `styles/` and `scripts/` folders will also be created. |
There was a problem hiding this comment.
Empty `icons/`, `styles/` and `scripts/` folders will also be created.
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Adds documentation for Shopify/slate-cli#108
cc @Shopify/themes-fed