Added a new recipe on how to publish new recipes#2334
Added a new recipe on how to publish new recipes#2334MMathisLab merged 2 commits intoDeepLabCut:mainfrom
Conversation
rizarae-p
changed the title
| *Date: 13 June 2023* | ||
|
|
||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
In general I would add information to first check whether a recipe or tutorial already exists and can be expanded. For instance, if it's related to I/O, maybe it can be added to I/O manipulations instead of being a completely new thing.
Definitely information about the structure of a recipe. We should expect that there will be some intro explaining why this can be useful, followed by examples/workflow.
There was a problem hiding this comment.
Great inputs, thanks @KonradDanielewski!
There was a problem hiding this comment.
Hi @KonradDanielewski ! I pushed new changes incorporating your comments. They were really helpful in improving the recipe. Thank you so much! 🎉
| Via terminal: | ||
| *** | ||
| ``` | ||
| cp new_recipe.ipynb path/to/DLC-repo/docs/recipes |
There was a problem hiding this comment.
On Windows the command is copy
|
|
||
| 5. Test locally by checking the `index.html` file in `path/to/DLC-repo/_build/html/` | ||
|
|
||
| 6. When everything is a-okay, commit to Git. If not, edit your file and go to back to step 1. |
There was a problem hiding this comment.
Should be first clarified that you should do all of this on your fork of the repo from which you create a pull request afterwards
| ``` | ||
| *** | ||
| The build log should look like below: | ||
| <img src="https://lh3.googleusercontent.com/pw/AIL4fc97W2rW08Mgc2I8vL8qi-Oo_a9klpK0Cly-huhENBe7f8BhXOZzASkbkAe2MLxUkRSyn0SvQm5Dc48iHNCxVnTqONtamUwLKXBtRzkHFpNNcGJwqJDuBKZFuA07RKpHm88f-W59Z7aVpYvYOkllUZfkGpj86q6DcYAX9CAuOdDhcnUcuMoLnheOpKtGU12BMJionXoLUhhpumvf7H2G6WL8yPg5PG8_prrjcKLRLznH5K9LqqwoiHKllsdyqqWAr9yycnnhjzjtczbZF2N1aiBt866uvRnYLO1QWyBD8ThwPKD4v2bqIW3DNjhVzcFOKQZFSqDNMeurk2MLfErxnD5gVAe_0n4ULMdQmXGiG5exEYcpINChDelAvyrxXwV2k1O3mEP6u5aYiqyoy4qFq7XtcH2ERnwgwfCWZLXdbBmgQl9kWJxbpPbOhJ9GZJiHswvVzxhEQrtSTLGGMCbF0W5QJYCv5o0Rdv1FYhGDwcgzSNl1W_1iMFoqr7KtUsTDObIZfrpttwBOA5W_-ZD8mlN8G210-ChluZ5poZEjgulZ6K5QcjblRtJCZdxGXYGLH5D1IMd5QCvMEQfmlkmuexzbb45ZicOqlIWdRngfltWmt_WCE86xTN5pVNV2iEnWQySyZ4FCTTwKfbWwsjaxbV0CUcecJFe4pTkfaCGJ5lpFVFIZDh96SBkMW2ma4sOmelHQMwKw5Hvt9THI8V1OlOtukT7xdf6Daal5OcGJ-RWmbwrHJxWFnS974I9FskWoateZw-P_8u8Qi7astUdbPR8zIOUt6iCgTVYlHfzKKhhJG54LL946tqDLVTuGFXo8rci58vQHk3Z8jhLAP0rAmqaILRoYrnsZI9GyuzkNvkwDM7jzstPAjkBy_9PTfJC04Ycw1nNOS5OnQEodxztU_0XGvQ8=w1387-h405-s-no?authuser=0"></img> |
There was a problem hiding this comment.
All images are now placeholder URLs so I don't know what's on them
|
Hey @KonradDanielewski and @rizarae-p want to make the suggested changes, then I can merge? :) |
Did a complete overhaul to make the recipe more lively and comprehensive to users
There was a problem hiding this comment.
Beautiful work @rizarae-p I think this can be merged @MMathisLab
3 participants
Added a new recipe for the DLC cookbook~