Improve CLI docs #31
Open
Improve CLI docs #31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oerc0122
force-pushed
the
improve-docs
branch
2 times, most recently
from
1fb16a2 to
1ef3985
Compare
oerc0122
had a problem deploying
to
github-pages
GitHub Actions
Failure
oerc0122
force-pushed
the
improve-docs
branch
from
b0d2ad2 to
c695256
Compare
Collaborator
ElliottKasoar
left a comment
ElliottKasoar
left a comment
There was a problem hiding this comment.
Generally looks great, just a few minor suggestions
|
|
||
| :: | ||
|
|
||
| data_collections validate examples/biosim_record.yaml |
Collaborator
There was a problem hiding this comment.
Suggested change
| data_collections validate examples/biosim_record.yaml | |
| data_collections validate data_collections_api/examples/biosim_record.yaml |
So this examples works from the root of the project?
| example is available). To do so, simply run:: | ||
|
|
||
| Dump a template metadata file ready for modification to upload. | ||
| data_collections dump my_metadata |
Collaborator
There was a problem hiding this comment.
Suggested change
| data_collections dump my_metadata | |
| data_collections dump my_metadata.json |
or .yml, so it works?
Comment on lines
+98
to
+100
| ``data_collections_api`` provides a method to quick-start building metadata, ``template`` will dump | ||
| an example metadata file for a particular community and data-type (though currently only a basic | ||
| example is available). To do so, simply run:: |
Collaborator
There was a problem hiding this comment.
Perhaps worth mentioning the format options?
oerc0122
force-pushed
the
improve-docs
branch
from
c695256 to
16a9379
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
Fixes
Addresses #18
To test
Read the docs.