Documentation Site Skeleton #17

Oreoz · 2018-03-14T16:26:00Z

Initial implementation of a documentation skeleton using ember-cli-addon-docs.

Linked to #15.

- Fixes most tests due to route hierarchy changes; - Adds template for `/docs`;

ef4 · 2018-03-14T17:20:25Z

package.json

@@ -17,9 +17,16 @@
  "license": "MIT",
  "devDependencies": {
    "broccoli-asset-rev": "^2.4.5",
+    "ember-ajax": "^3.1.0",


Which thing depends on this?

ember-cli-addon-docs depends on it currently, but it's not currently listed as a dependency.

ember-learn/ember-cli-addon-docs#76

ef4 · 2018-03-14T17:37:58Z

Thanks for getting this started, looks nice.

At least some of the test failures are legitimately detecting demos that don't look right anymore. We'll need to figure out why.

- Reinstates the TimeLord to the `demos` route; - Removes the uselss `demos/docs` template;

knownasilya · 2018-03-15T15:05:15Z

config/addon-docs.js

+/* eslint-env node */
+'use strict';
+
+const AddonDocsConfig = require('ember-cli-addon-docs/lib/config');


Need

// eslint-disable-next-line node/no-unpublished-require

above line 4 to get tests to pass.

👍 Just added this -- thanks!

I took a closer look at this rule, and disabling it here is just a workaround.

The more complete solution is to create a files entry in our package.json. This would make it clear that config/addon-docs.js is not something we publish to consumers of the library, which would cause the unpublished rule to not worry about our use of a devDependency here.

(Or instead of files we could also use .npmignore, which looks like it may be easier for this use case. Basically we just need to prove that config/addon-docs.js does not get published to npm.)

Ah, I see there is already an open issue for this on ember-cli-addon-docs: ember-learn/ember-cli-addon-docs#103

And a PR ember-learn/ember-cli-addon-docs#105

Oreoz · 2018-03-15T16:11:36Z

@ef4 We got green tests -- thanks to @knownasilya. 🎉 I started converting your initial comments in sprite.js to JSDoc as a proof that API References will be automatically generated/maintained using this format.

ef4 · 2018-03-15T20:35:11Z

tests/dummy/app/adapters/person.js

@@ -14,7 +14,7 @@ export default DS.JSONAPIAdapter.extend({
          id: String(i),
          attributes: Object.seal({
            name: faker.name.firstName(),
-            'avatar-url': faker.internet.avatar()
+            avatarUrl: faker.internet.avatar()


I'm very confused why this was needed. Is ember-cli-addon-docs altering something about our default adapters?

The data returned here is supposed to look like a network request (meaning kebab-case is the standard). And it works on master the way I had it, but on this branch it only works with camelCase.

I found it, ember-cli-addon-docs is indeed messing with the application serializer.

ember-learn/ember-cli-addon-docs#107

knownasilya · 2018-03-15T22:21:46Z

Looks like tests are timing out.

ef4 · 2018-03-16T00:28:52Z

There are still demo problems that weren't caught by the test suite. I'm investigating.

For example, if you try running /demos/bind you'll see it doesn't move smoothly anymore.

And /demos/orphans animates in but not out.

ef4 · 2018-03-16T00:36:02Z

Disregard the part about /demos/orphans, I just realized it's also broken on master.

Because they're passing now and I want to know if that changes.

and drop unused bower.json because it causes some spurious errors in ember-try

knownasilya · 2018-03-16T13:53:20Z

Some of the tests timeout and others error with Cannot find module 'recast'

ef4 · 2018-03-16T15:23:08Z

Yeah and it’s only happening on Travis. I have everything working fine when I try locally.

…

On Fri, Mar 16, 2018 at 6:53 AM Ilya Radchenko ***@***.***> wrote: Some of the tests timeout and others error with Cannot find module 'recast' — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#17 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AATfMp2qpHHJro71ZCqC9EgqJcrJzjVeks5te8PSgaJpZM4SqwWn> .

knownasilya · 2018-03-16T15:36:00Z

@ef4 are you using yarn to install locally? The ci is not, it says add useYarn: true to the config in ember-try I think.

ef4 · 2018-03-16T15:52:19Z

Yes, I'm running ember try:one directly just like in CI, so I'm also using npm. But that gives me an idea: I think I'm using a different npm version than travis.

To avoid possible npm5 issues

knownasilya · 2018-03-16T16:11:40Z

Looking good so far, one passed 👍

knownasilya · 2018-03-16T19:37:34Z

Woot!

Unknown added 5 commits March 13, 2018 21:12

Adds ember-cli-addon-docs

c830d73

- Modify route hierarchy of demo to accomodate demos and docs;

ae67ff6

- Fixes most tests due to route hierarchy changes; - Adds template for `/docs`;

Adds not-found route and template

b77d22a

Adds rough documentation skeleton

004cf8a

Uses homepage class for demo menu

3a32262

ef4 reviewed Mar 14, 2018

View reviewed changes

Turbo87 mentioned this pull request Mar 14, 2018

Move existing dummy app routes to /demos subroute #20

Merged

Oreoz and others added 4 commits March 14, 2018 14:44

Merge branch 'master' into docs

5fc934a

Mock the avatars;

f209f84

Cleaning the demos route

eff4f0c

- Reinstates the TimeLord to the `demos` route; - Removes the uselss `demos/docs` template;

Transforms some initial comments into JSDoc

3fedb1f

knownasilya reviewed Mar 15, 2018

View reviewed changes

Disables eslint for unpublished require

1b11921

ef4 reviewed Mar 15, 2018

View reviewed changes

ef4 added 2 commits March 15, 2018 14:43

use fixed addon-docs that doesn't alter our adapters

16eb55b

switch to npmignore to satisfy no-unpublished-require warning

6409e5b

ef4 added 3 commits March 15, 2018 19:07

make beta and canary mandatory on travis

fa7a005

Because they're passing now and I want to know if that changes.

Merge remote-tracking branch 'origin/master' into docs

a1a3be0

match ember-data version with ember-cli-addon-docs's version

ccb34ef

and drop unused bower.json because it causes some spurious errors in ember-try

ef4 mentioned this pull request Mar 16, 2018

Fixes the dummy app demo links index. #23

Merged

Merge branch 'master' into docs

5765d38

switching to yarn in ember-try

155c37d

To avoid possible npm5 issues

I think canary reintroduced event-dropping bug

4b44a00

ef4 merged commit bd85e1a into ember-animation:master Mar 16, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation Site Skeleton #17

Documentation Site Skeleton #17

Oreoz commented Mar 14, 2018

ef4 Mar 14, 2018

Oreoz Mar 14, 2018

ef4 commented Mar 14, 2018

knownasilya Mar 15, 2018

Oreoz Mar 15, 2018

ef4 Mar 15, 2018

ef4 Mar 15, 2018

ef4 Mar 15, 2018

knownasilya Mar 15, 2018

Oreoz commented Mar 15, 2018

ef4 Mar 15, 2018

ef4 Mar 15, 2018

ef4 Mar 15, 2018

knownasilya commented Mar 15, 2018

ef4 commented Mar 16, 2018

ef4 commented Mar 16, 2018

knownasilya commented Mar 16, 2018

ef4 commented Mar 16, 2018 via email

knownasilya commented Mar 16, 2018

ef4 commented Mar 16, 2018

knownasilya commented Mar 16, 2018

knownasilya commented Mar 16, 2018

Documentation Site Skeleton #17

Documentation Site Skeleton #17

Conversation

Oreoz commented Mar 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ef4 commented Mar 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Oreoz commented Mar 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

knownasilya commented Mar 15, 2018

ef4 commented Mar 16, 2018

ef4 commented Mar 16, 2018

knownasilya commented Mar 16, 2018

ef4 commented Mar 16, 2018 via email

knownasilya commented Mar 16, 2018

ef4 commented Mar 16, 2018

knownasilya commented Mar 16, 2018

knownasilya commented Mar 16, 2018