Media contributor guide: add Gold drawing #122
Conversation
|
I've added only the process to add a new Gold image: https://github.com/Nautilus-Cyberneering/chinese-ideographs/blob/issue-121-media-contributor-guide/documentation/Media%20Contributor%20Guide.md |
| In this tutorial, you will learn how to add a new Gold Drawing image to the library. | ||
|
|
||
| You can watch the whole screen capture of this tutorial on [YouTube](https://youtu.be/Nf-ePEdA5xc). | ||
|
|
There was a problem hiding this comment.
Maybe I would include a two lines description of what a Gold Image is ("A HQ Image generated from the raw acquired, with no further processing but cropping, aligning and some small resizing")
There was a problem hiding this comment.
Yes, in fact, we should add that descripción here and link this tutorial with that section.
|
|
||
| We are using `dvc` to store the image. That means the actual image will be stored on the `dvc` storage and we will only add two files into the git repo. | ||
|
|
||
| First, we use the `dvc` client to add the new image. We have already added the image in the rigth folder. The `dcv` command is: |
There was a problem hiding this comment.
Here the second time you mention dvc you have misspelled it.
| At this point we have the image locally in our branch. We need to apply our changes remotelly: | ||
|
|
||
| - Push our new git commit. | ||
| - Copy the image to the remote `dcv` storage. |
|
|
||
| ### 6. Validate and merge the pull requests | ||
|
|
||
| If there were not any error, a maintainer can merge the pull request. This role should be a media maintainer in charge of the image collection. |
There was a problem hiding this comment.
"If there were not any error" -- The verb tense seems off.
I would you use the active voice: is
|
|
||
| ### 7. New version of the website deployed | ||
|
|
||
| If there were no errors in the previous stepts you should see the new Gold drawing on the website: https://nautilus-cyberneering.github.io/chinese-ideographs-website. |
There was a problem hiding this comment.
Same as the previous.
Active voice.
|
|
||
| ## How to update a Gold Drawing | ||
|
|
||
| In this tutorial, you will learn how to update a new Gold Drawing image to the library. |
There was a problem hiding this comment.
Whe you say update it will lead to a modification.
To update and new are slightly contradictive.
If it is new it means to add.
If there is already a version it should be without new and simply update.
|
|
||
| In this tutorial, you will learn how to update a new Gold Drawing image to the library. | ||
|
|
||
| NOTE: The intention is to update an image. If you want to add the artist revision or edition, that's a different artwork, so you should add a new image. The "update" case should only be used when you want to fix the wrong image (invalid, file, corrupted file, wrong content, etcetera). |
There was a problem hiding this comment.
"If you want to add the artist revision or edition" --- ... artist's ...
"that's a different artwork," -- ... which is a different artwork
"when you want to fix the wrong image (invalid, file,.." --- when you want to fix a faulty image....
There was a problem hiding this comment.
Hi @josecelano ,
I reviewed the English and I found some things to improve.
Please have a look at them.
Thank you very much.
|
|
||
| If there were no errors in the previous stepts you should see the new Gold drawing on the website: https://nautilus-cyberneering.github.io/chinese-ideographs-website. | ||
|
|
||
| The website contains another workflow which is triggered by the [update-website workflow](../.github/workflows/update-website.yml). That workflow obtains the image from the `dvc` storage and convert it to `JPG` format. It also copies the image inside the git repo (it's not using git LFS). You can get more information about that process on the [website repository](https://nautilus-cyberneering.github.io/chinese-ideographs-website/). |
There was a problem hiding this comment.
Thin link to the "website repository", links directly to the website instead.
| @@ -0,0 +1,178 @@ | |||
| # Media Contributor Guide | |||
|
|
|||
There was a problem hiding this comment.
Maybe add an index for the document. With a brief overview of the steps.
|
hi @da2ce7 regarding updating the Gold Drawing and continuing with our previous discussion, how should we proceed? As you mentioned we only want to add and delete images and the modification should be an delete & add operation, but there are some steps in the process:
The example cases for an update are:
The final branch changes are going to be two commits:
Instead of a single commit changing the content of the dvc pointer. But my question is, should we apply that approach only to the COMMIT (3) step in the list of tasks above? I mean do we have to apply this approach only to the changes in the git repo or do we have to change also the whole process? I would keep the other steps, for example:
From the media contributor point of view, the process is an update and internally we implement a delete and add action. Delete:
Add:
Definitely having only two operations from the code point of view it's going to be much simpler, and it seems to better try to keep the same process at all levels but I'm not sure if that could be too complicated for the media contributor. Although it should not be a frequent task. By the way, I've just realized we could copy&paste the issue description into the (long) commit message if we want to have the reason inside git. |
|
I think I've updated it with all your suggestions @da2ce7 @cgbosse @yeraydavidrodriguez |
Documentation: Media Contributor Guide.
How to handle the library (images) from a final user point of view, or at least someone who is only focused on the contents.