Doc requirements for platform api expectations #1
Conversation
There was a problem hiding this comment.
Woo, awesome job. This is a fantastic start. I dropped like a million comments and I think there's a bit more work to do but we're definitely on the right track.
Other than my specific comments, a few overall nits:
- can we line up the reference API documentation so it is a bit more similar to, for example, the plugin API documentation? e.g. the Media plugin ref docs?
- can we ensure to backtick any code object references or plugin names?
- I would be down to move this into the README than keep it in a separate document. My two cents.
Thanks for taking this on @audreyso ! I think nailing this document will really reduce the barrier to entry to contributing to Cordova. Keep up the good work.
PlatformRequirements.md
Outdated
| - bin/create.bat for windows | ||
| - windows .bat file typically just calls bin/create with node | ||
|
|
||
| bin/update |
There was a problem hiding this comment.
I think we should remove this, as the update script seems to be going away, e.g. https://issues.apache.org/jira/browse/CB-12948
PlatformRequirements.md
Outdated
| - path to local repo of valid plugin: /my/cordova/repositories/cordova-plugin-globalization | ||
| - The `removePlugin` method must return a promise either fulfilled or rejected with a CordovaError instance. | ||
|
|
||
| - CLI work flow integration |
There was a problem hiding this comment.
Perhaps it is worth linking to / expanding on the two different kinds of workflows cordova supports? I.e. CLI-based workflow (supporting multiple platforms) or single-platform-based workflow that purely leverages the platform API. e.g. the top of the Android guide describes there are "platform centered shell tools" or "cross-platform Cordova CLI" workflows.
|
Another thing to note is that the tests that are in this repo could be used to verify the platformAPI for anyone attempting to implement it. |
audreyso
force-pushed
the
DocRequirements
branch
13 times, most recently
from
ea28b27
to
839c321
Compare
audreyso
force-pushed
the
DocRequirements
branch
from
839c321
to
0c0f950
Compare
audreyso
force-pushed
the
DocRequirements
branch
from
0c0f950
to
9c434ee
Compare
|
This seems almost ready to merge. What about those last two comments @filmaj @purplecabbage @audreyso? Do you have suggestions what the text should be replaced with so this can be taken care of and merged? |
|
Went through the review comments and resolved the ones that were definitely taken care of before merging, left the ones that are not 100% explained or done yet and might need a new PR to fix. |
Ready for review!
Platforms affected
What does this PR do?
Document requirements for platform api expectations
What testing has been done on this change?
Checklist