Repository navigation
Update modelforge documentation - #30
Conversation
|
EDIT: there will probably be changes -- regarding naming -- from #29 So anyway I put separated doc for commands/API in two files, and modified a bit the README. |
zurk
left a comment
zurk
left a comment
There was a problem hiding this comment.
just several remarks, not fully reviewed.
| @@ -1,25 +0,0 @@ | |||
| # Minimal makefile for Sphinx documentation | |||
There was a problem hiding this comment.
Are you sure we do not need the files you deleted anymore?
There was a problem hiding this comment.
No, was waiting for @vmarkovtsev 's input on this. I have no idea what is the purpose of these, although since they were not modified since july of last year I don't imagine they are important.
There was a problem hiding this comment.
This is the legacy of src-d/docsrv and can be removed
| @@ -0,0 +1,50 @@ | |||
| # API usage | |||
There was a problem hiding this comment.
please add a link to API usage file to the README.
| @@ -0,0 +1,161 @@ | |||
| # Command line usage | |||
There was a problem hiding this comment.
please add a link to CLI usage to the README
There was a problem hiding this comment.
it exists see Usage sub section.
|
Rebased off #29 |
| VENDOR = "source{d}" # name of the issuing vendor for models | ||
| BACKEND = "gcs" # type of backend to use | ||
| BACKEND_ARGS = "bucket='models.cdn.sourced.tech',credentials='key.json'" # all backend arguments | ||
| DEFAULT_REPO = "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/src-d/models" # git repo for the index |
There was a problem hiding this comment.
Ok this looks ugly, I should not have changed. Let's rename to INDEX_REPO and CACHE_DIR
| python3 -m unittest discover /path/to/modelforge | ||
| ``` | ||
|
|
||
| If you wish to make your model available in [src-d/models](https://github.com/src-d/models), please |
There was a problem hiding this comment.
We want to remove any source{d} branding. Change src-d to user everywhere and explain that it is an example.
There was a problem hiding this comment.
btw apart from all the other branding in cmd.md and readme.md that i removed, do you also want this part out ? since in the contributions section i thought it would be ok to leave it as is
There was a problem hiding this comment.
Yes. We can refer to src-d/models as an example but the code snippets should be neutral.
| inheriting from the `StorageBackend` class in `storage_backend.py`, and define the following | ||
| methods: | ||
|
|
||
| - `initialize_backend(self, force: bool)`: should initialize the backend. An error should be raised if |
There was a problem hiding this comment.
We renamed it to reset()
Signed-off-by: Romain Keramitas <r.keramitas@gmail.com>
|
Since this PR is about documentation, I'd add @campoy as a reviewer. |
|
I think it is better to post-review here, otherwise we will wait much time without any updated docs at all. |
4 participants
Last split, simply an update to the doc.