Skip to content

Commit

Permalink
Update documentation language
Browse files Browse the repository at this point in the history
  • Loading branch information
bendemboski committed Nov 22, 2019
1 parent 1445f59 commit 5bcea88
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Documentation

Ember-Electron is a small open source project. Use [GitHub Issues](https://github.com/adopted-ember-addons/ember-electron/issues) to report bugs and errors within the addon.

If you need help *using* the addon with your application, may we recommend the excellent Ember community? You can the [various places to get help here](https://www.emberjs.com/community/). If you have questions regarding Electron, their [Slack and forum](https://electron.atom.io/contact/) will be helpful as well.
If you need help *using* the addon with your application, may we recommend the excellent Ember community? You can check out the [various places to get help here](https://www.emberjs.com/community/). In particular, the [Ember community Discord](https://discordapp.com/invite/emberjs) has a `#topic-desktop` channel which is a great place to ask questions about `ember-electron`. If you have questions regarding Electron, their [Slack and forum](https://electron.atom.io/contact/) will be helpful as well.


## Authors
Expand Down
6 changes: 3 additions & 3 deletions tests/dummy/app/templates/docs/guides/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ protocolServe({

### test-main.js

Generally you should not need to migrate `test-main.js` at all. It's default content in 2.x was:
Generally you should not need to migrate `test-main.js` at all. Its default content in 2.x was:

```javascript
/* eslint-env node */
Expand All @@ -111,9 +111,9 @@ If you don't have any files in any of the `ember-electron/resources` or `ember-e

`ember-electron` 2.x managed the `resources-*` folders to allow you to specify platform-specific resources. `electron-forge` does not support this functionality, and it was one of the main factors contributing to the complexity and slowness of `ember-electron` 2.x's build pipeline, so it's been removed in 3.x.

So if you only have content in `ember-electron/resources/`, you can just copy the folder into `electron-app`. Note that `src/index.js` is now in a subfolder, unlike `main.js` was in 2.x, so if you are accessing resources from your main process using, e.g., `path.join(__dirname, 'resources')`, you'll have to update it to `path.join(__dirname, '..', 'resources')` (or you could put the `resources` folder in the `src/` directory if you're some kind of monster).
So if you only have content in ember-electron/resources/, you can copy the folder into electron-app and ignore the other ember-electron/resources-* folders. Note that `src/index.js` is now in a subfolder, unlike `main.js` was in 2.x, so if you are accessing resources from your main process using, e.g., `path.join(__dirname, 'resources')`, you'll have to update it to `path.join(__dirname, '..', 'resources')` (or you could put the `resources` folder in the `src/` directory if you like, although many folks prefer to not mix their code with non-code resources.)

If you do have content in the platform-specific `resources-*` folders, you can between them at runtime, e.g. put your platform-specific resources in `resources/win32`, `resources/darwin`, and `resources-linux` and:
If you do have content in the platform-specific `resources-*` folders, you can choose between them at runtime, e.g. put your platform-specific resources in `resources/win32`, `resources/darwin`, and `resources-linux` and:

```javascript
let resourcePath = path.join('..', 'resources', process.platform, 'thing.json.txt');
Expand Down
2 changes: 1 addition & 1 deletion tests/dummy/app/templates/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Somethings missing? Contributions to our docs are welcome!

Ember-Electron is a small open source project. Use [GitHub Issues](https://github.com/adopted-ember-addons/ember-electron/issues) to report bugs and errors within the addon.

If you need help *using* the addon with your application, may we recommend the excellent Ember community? You can the [various places to get help here](https://www.emberjs.com/community/). In particular, the [Ember community Discord](https://discordapp.com/invite/emberjs) has a `#topic-desktop` channel which is a great place to ask questions about `ember-electron`. If you have questions regarding Electron, their [Slack and forum](https://electron.atom.io/contact/) will be helpful as well.
If you need help *using* the addon with your application, may we recommend the excellent Ember community? You can check out the [various places to get help here](https://www.emberjs.com/community/). In particular, the [Ember community Discord](https://discordapp.com/invite/emberjs) has a `#topic-desktop` channel which is a great place to ask questions about `ember-electron`. If you have questions regarding Electron, their [Slack and forum](https://electron.atom.io/contact/) will be helpful as well.


## Authors
Expand Down

0 comments on commit 5bcea88

Please sign in to comment.