Skip to content
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

Merged
merged 5 commits into from
Mar 5, 2019
Merged

Conversation

richardsliu
Copy link
Collaborator

@richardsliu richardsliu commented Mar 4, 2019

Part of kubeflow/training-operator#731


This change is Reviewable

@richardsliu
Copy link
Collaborator Author

/assign @sarahmaddox

Copy link
Contributor

@sarahmaddox sarahmaddox left a 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
+++

Copy link
Contributor

@sarahmaddox sarahmaddox left a 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.

content/docs/reference/tfjob/v1beta2/tensorflow.md Outdated Show resolved Hide resolved
content/docs/reference/tfjob/v1beta2/tensorflow.md Outdated Show resolved Hide resolved
content/docs/reference/tfjob/v1beta2/tensorflow.md Outdated Show resolved Hide resolved
content/docs/reference/tfjob/v1beta2/tensorflow.md Outdated Show resolved Hide resolved
content/docs/reference/tfjob/v1beta2/tensorflow.md Outdated Show resolved Hide resolved
@richardsliu
Copy link
Collaborator Author

@sarahmaddox Links should work now.

Copy link
Contributor

@sarahmaddox sarahmaddox left a 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.

@richardsliu
Copy link
Collaborator Author

Couple of options:

  1. We can just generate the same documentation for v1beta1 which is already released, or
  2. Hold off until 0.5.0 release.

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.

@richardsliu
Copy link
Collaborator Author

@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.

@sarahmaddox
Copy link
Contributor

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.

@sarahmaddox
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit dfba82e into kubeflow:master Mar 5, 2019
@richardsliu richardsliu deleted the tfjob_refs branch March 5, 2019 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants