Assist users in contributing new tutorials #2148
Conversation
Major update to assist user in contributing new tutorials.
✅ Deploy Preview for pytorch-tutorials-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| a result of, for example, updates to Python or PyTorch or other | ||
| packages. If your tutorial fails to build in our Continuous Integration | ||
| (CI) system, we might contact you in order to resolve the issue. | ||
|
|
There was a problem hiding this comment.
We can probably say that something like: If your tutorial relies on dependancies not defined in the requirements.txt file, you can add them there.
There was a problem hiding this comment.
I've added this text to the beginning of this section, so that they add any extra packages they need to requirements.txt.
CONTRIBUTING.md
Outdated
| take the tutorial off the site. | ||
|
|
||
|
|
||
| # Guidance for authoring tutorials and recipes # |
There was a problem hiding this comment.
do you need that "#" at the end of the line?
There was a problem hiding this comment.
:-P . . . No, the trailing hash marks are optional; it is just a habit that I am in when writing Markdown. They are there in all the headers that I added . . . :-P . . . I don't want to change all of them right now because I am concerned that in making a bunch of edits, I might disrupt something else in the file. The trailing hash marks are not visible when the file renders, so my preference is to merge the current version and then remove the hash marks in some future PR.
| ## Test Your Tutorial Locally ## | ||
|
|
||
| The following command builds an HTML version of the tutorial website. | ||
|
|
There was a problem hiding this comment.
Yes, added the enclosing backquotes.
…rljparker-contributing-1
|
LGTM! |
Major update to assist user in contributing new tutorials.