Closed ghost closed 4 years ago
I reread the README and I was missing yarn start:local
which points to the local server listening on port 5050. If I run yarn start:local
in ember-api-docs, however, I get another error because ember-api-docs cannot find the ember.json
payload:
I would expect to preview just ember-data API documentation locally but could be wrong there as well.
If you need the entire docs to show up, then run yarn start
without any args. The additional params is required when you're trying to build a specific version of ember/ember-data to view its output.
This isn't a great UX atm. This app is going to be rewritten over the next month to simplify it & to add new features from https://github.com/ember-learn/ember-jsonapi-docs/projects/1, so at the end of that, these kind of issues should be sorted out.
If you need the entire docs to show up, then run yarn start without any args. The additional params is required when you're trying to build a specific version of ember/ember-data to view its output.
Ah, I think this makes more sense. So I would only want to run that command to work with the YUI doc output directly, not to run in the full api docs app.
Sounds great about upcoming UX improvements. Feel free to ping me for some user testing.
So I'm guessing I cannot build a single projects version of the documentation?
I cannot run yarn start
because I do not have the S3 credentials:
yarn start
yarn run v1.17.3
$ node index.js
Downloading docs for ember & ember-data
Error: Command failed with exit code 1 (EPERM): aws s3 sync s3://api-docs.emberjs.com/rev-index tmp/rev-index
Any valid s3 credential (even your own) can be used for the setup. The readme has details around it.
Interesting. Apparently my S3 credentials don't work 😆:
aws s3 ls s3://api-docs.emberjs.com/rev-index/
An error occurred (AccessDenied) when calling the ListObjectsV2 operation: Access Denied
Thanks for the help too. I will see about trying later with other S3 credentials.
@sivakumar-kailasam @Gaurav0 I am continuing the discussion from https://github.com/emberjs/data/pull/6449 I would like to test that PR locally but seem to only see versions up to 3.12 listed in the left navigation.
steps
Following the steps in the README.md. I have local clones of ember.js, ember-data, and ember-api-docs in the parent directory.
yarn gen --project ember-data --version 3.14.0
logs
yarn server
ember-api-docs
, runember serve
I can navigate to the docs app fine but I only see
3.12
listed in the dropdown but would expect to see3.14
:Is this expectation correct? Or have I missed a step somewhere?