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.

Sign up for GitHub

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

Jump to bottom

update generated api-reference docs for 1.10 #7856

Merged
merged 1 commit into from
Mar 27, 2018
Merged

update generated api-reference docs for 1.10 #7856

merged 1 commit into from
Mar 27, 2018

Conversation

Bradamant3
Copy link
Contributor

@Bradamant3 Bradamant3 commented Mar 26, 2018 •
edited
Loading

Also updated the _data/reference.yml file, in addition to the generated docs.

It looks as though the issue with the make copyapi -- or possibly with cp, haven't checked that far -- is that it does not like to create directory names with punctuation in them. Or least, not with either dashes or periods. Not fully tested yet, not sure what to recommend going forward. Will ponder later. Thanks for all your help.

Addendum: the previous is not correct. Or at least, it does not appear to be an issue with the generated kubectl docs.

/assign @steveperry-53

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 26, 2018
@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 26, 2018
@Bradamant3 Bradamant3 added this to the 1.10 milestone Mar 26, 2018
@k8sio-netlify-preview-bot
Copy link
Collaborator

Deploy preview for kubernetes-io-vnext-staging ready!

Built with commit 9e4cb50

https://deploy-preview-7856--kubernetes-io-vnext-staging.netlify.com

@zacharysarah
Copy link
Contributor

/lgtm
/approve
/hold
@Bradamant3 Please feel free to remove the /hold when you're ready.

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Mar 26, 2018
@steveperry-53
Copy link
Contributor

@Bradamant3 Initial pass: It doesn't seem right that we have several cases of "File renamed without changes". I'll look a little deeper.

@Bradamant3
Copy link
Contributor Author

@steveperry-53 you've been through this before, so I'll defer to you. But when I saw those "File renamed without changes" diffs, I also noticed that they are all css/js files for presenting the content. They aren't content files themselves. So I'd sort of expect them to remain the same.

@steveperry-53
Copy link
Contributor

steveperry-53 commented Mar 26, 2018 •
edited
Loading

Apparently I missed a critical step in the docs: creating a new directory to receive the copied files.
I just tried this:

In my local kubernetes/website/docs/reference/generated/kubernetes-api,
mkdir v1.10
cp -r v1.9/* v1.10

Now back in my local kubernetes-incubator/reference-docs,
make copyapi

That gives me these new files in my local kubernetes/website:

new file:   docs/reference/generated/kubernetes-api/v1.10/index.html
        new file:   docs/reference/generated/kubernetes-api/v1.10/navData.js
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/bootstrap/dist/css/bootstrap.min.css
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/css/font-awesome.css
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/css/font-awesome.css.map
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/css/font-awesome.min.css
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/fonts/FontAwesome.otf
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/fonts/fontawesome-webfont.eot
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/fonts/fontawesome-webfont.svg
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/fonts/fontawesome-webfont.ttf
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/fonts/fontawesome-webfont.woff
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/font-awesome/fonts/fontawesome-webfont.woff2
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/highlight.js/styles/default.css
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/jquery.scrollto/jquery.scrollTo.min.js
        new file:   docs/reference/generated/kubernetes-api/v1.10/node_modules/jquery/dist/jquery.min.js
        new file:   docs/reference/generated/kubernetes-api/v1.10/scroll.js
        new file:   docs/reference/generated/kubernetes-api/v1.10/stylesheet.css
        new file:   docs/reference/generated/kubernetes-api/v1.10/tabvisibility.js

@Bradamant3
Copy link
Contributor Author

hrm. OK, running various things again. bc kubectl docs also messed up.

@steveperry-53
Copy link
Contributor

@Bradamant3 Given that you deleted the 1.9 files, I think this PR is correct.
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: steveperry-53, zacharysarah

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:
  • OWNERS [steveperry-53,zacharysarah]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Bradamant3
Copy link
Contributor Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 27, 2018
@k8s-ci-robot k8s-ci-robot merged commit dbbd826 into release-1.10 Mar 27, 2018
steveperry-53 pushed a commit to steveperry-53/website that referenced this pull request Mar 27, 2018
@Bradamant3 @steveperry-53
update generated api-reference docs for 1.10 (kubernetes#7856)
54a0c47
k8s-ci-robot pushed a commit that referenced this pull request Mar 27, 2018
@steveperry-53 @k8s-ci-robot
update generated api-reference docs for 1.10 (#7856) (#7864)
17323ce
chenopis added a commit that referenced this pull request Mar 27, 2018
@chenopis
Merge branch 'master' of https://github.com/kubernetes/website into r…
f09ceb1 
…elease-1.10

* 'master' of https://github.com/kubernetes/website:
  Update overview.md (#7836)
  Consolidate all upgrade/downgrade admin tasks (#7735)
  add generated docs for tools and components (#7845) (#7866)
  update generated api-reference docs for 1.10 (#7856) (#7864)
  Merge 1.10 to master for release (#7861)
zacharysarah pushed a commit that referenced this pull request Apr 16, 2018
@Bradamant3
update generated api-reference docs for 1.10 (#7856)
3352e64
@chenopis chenopis deleted the bradamant3-apirefdocs-1.10 branch April 27, 2018 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tengqm tengqm Awaiting requested review from tengqm

@zhangxiaoyu-zidif zhangxiaoyu-zidif Awaiting requested review from zhangxiaoyu-zidif

Assignees

@zacharysarah zacharysarah

@steveperry-53 steveperry-53

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
1.10
Development

Successfully merging this pull request may close these issues.
5 participants
@Bradamant3 @k8sio-netlify-preview-bot @zacharysarah @steveperry-53 @k8s-ci-robot