New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added Visual Studio Code tutorial, and updated README #961
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of being an user-level tutorial, should this be a developer guide that's linked in https://github.com/tensorflow/io/blob/master/CONTRIBUTING.md?
@terrytangyuan I think the content is suitable for part of the https://tensorflow.org/io, so the tutorial format might be good for developers to follow. |
@yongtang is right, I'm following existing tf.io docs structure to make sure that tensorflow docs integration works as expected. Will be happy to move / restructure if necessary. |
/cc @tensorflow/docs-team to take a look. |
Seems out of place for tutorials: https://www.tensorflow.org/io/overview ---which I expect to contain example of tasks that use TFIO. But projects can have install and build guides, for example: https://www.tensorflow.org/federated/install |
@lamberta @vlasenkoalexey I think have a page of install like https://www.tensorflow.org/federated/install would make sense. Do you know what will need to be updated or change in the PR? Should the content be placed in a directory called |
Yeah, I'd move it out of tutorials to the /docs root. Probably don't need a docs/install directory until there's more content to put there. A lot of projects have something similiar, here's the TFQ install: https://www.tensorflow.org/quantum/install (and here's how their _book.yaml) is set up) |
Moved vscode instructions to docs root, @lamberta please take a look |
Thanks. Need to add to the leftnav somewhere. Not sure how this project is set up, I see a docs/_toc.yaml file and a docs/tutorials/_toc.yaml file---I assume this should be added to the former cc: @MarkDaoust |
Yes, docs/_toc.yaml makes the first section, tutorials/_toc.yaml makes the second section in the left-nav here: |
As far as I understand it should go below Overview section in docs/_toc.yaml similarly to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me ..
last thing, can you create a docs/images
directory and move the image in there. Thanks
* Added Visual Studio Code tutorial, and updated README * merged and reformatted * added missing line break * moved vscode setup instructions to docs root * added VS code instructions to leftnav below Overview section * moved docs/vscode/vscode_debugger.png -> docs/images/vscode_debugger.png
No description provided.