-
Notifications
You must be signed in to change notification settings - Fork 777
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
Add TFJob reference htmls #516
Conversation
/assign @sarahmaddox |
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.
Thanks! A few comments from me:
-
I think you're right about using .md - let's change the file extensions from .html to .md.
-
Please change
/references/
to/reference/
in the file path, to align with my PR Added the framework for API references. #514 -
Please add this markup to the top of each file. I hope this will make Hugo treat the file as a web page that needs the header and navigation chrome around it:
in common.md
:
+++
title = "TFJob Common"
description = "Reference documentation for TFJob"
weight = 100
+++
and in tensorflow.md
:
+++
title = "TFJob TensorFlow"
description = "Reference documentation for TFJob"
weight = 100
+++
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.
Looking much better! Just some broken links - see comments.
@sarahmaddox Links should work now. |
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.
Cool, this LGTM. Do we need to hold off until the release date? I won't add an LGTM or approve comment until I hear from you.
Couple of options:
Either way we have to release again when v1beta2 comes along. I prefer option 1, we are supposed to have API documentation for Beta releases anyway. |
@sarahmaddox I've pushed the changes to v1beta1. For v1beta2, I've added "in development" to the title since it is not yet released. We can merge this PR if you are ok with it. |
Nice! And actually, the website does reflect master (we've already created the doc archive for 0.4) so it's fine to publish docs related to 0.5 provided we clearly mark them as such. |
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sarahmaddox The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Part of kubeflow/training-operator#731
This change is