Update README with more details about the project and its setup. #85
Conversation
alexeykostevich
commented
Apr 20, 2020
alexeykostevich
commented
- Add more information about the project for new contributors.
- Update docs according to the latest API of the commands.
- Update quickstarts with detailed instructions for both local and AWS-based setup.
- Add more information about the project for new contributors. - Update docs according to the latest API of the commands. - Update quickstarts with detailed instructions for both local and AWS-based setup.
|
This PR is the result of my research of the environment setup, which we discussed on the last Ember Learn meeting. Overall, I found just a few mismatches between the docs and the actual API (e.g. the lack of
Being I'm a newcomer, it was a bit hard for me to jump in straightaway without looking into the code. Therefore, I've tried to digest the docs and provide more information for new contributors. The PR also updates the docs according to the latest tool's API. Here is how it looks like now: https://github.com/alexeykostevich/ember-jsonapi-docs/blob/doc/readme-update/README.md @mansona , @jenweber, @MelSumner , please, let me know if you have any concerns about the structure and format of the docs. Also, I would like to ask you to carefully review the Overriding a specific version of YUIDoc file with a local copy (for core contributors). section, since I was not able to actually test it. However, I'm 90% confident that it is correct. |
|
Hi @Gaurav0, if you have time, could you have a read through this? Thanks! |
Co-Authored-By: Jen Weber <weberj10@gmail.com>
There was a problem hiding this comment.
This is a huge improvement. Thanks for your hard work, @alexeykostevich
@sivakumar-kailasam Do you want to review as well?
| You can do this by passing `--project ember/ember-data --version 2.11.1` as an argument to the index script. e.g., `yarn start --project ember --version 2.11.0`. | ||
| You need an additional flag `AWS_SHOULD_PUBLISH=true` for publishing the docs. | ||
| ```bash | ||
| # Clone Ember.js and Ember Data repositories. |
There was a problem hiding this comment.
We should make the structure of the docs clear. ember.js, data, ember-api-docs, and ember-jsonapi-docs should all be cloned in the same directory.
There was a problem hiding this comment.
That's an excellent point! I'll create another PR to include this information.
| ## Generating API Documentation and Testing API Docs Locally | ||
| # Generate docs for a particular project/release. | ||
| yarn gen --project ember --version 3.17.0 | ||
| yarn gen --project ember-data --version 3.17.0 |
There was a problem hiding this comment.
Another gotcha: the version here should match the one in the package.json of your project, but you can't use 'beta' or 'canary'. So for example if the ember-data package.json says "3.19.0-beta.2" use "3.19.0".
There was a problem hiding this comment.
Got it! Thank you for sharing! I'll create another PR to include this information.
