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

Fix broken update-imported-docs.sh #4283

Closed
2 tasks
ahmetb opened this issue Jul 5, 2017 · 16 comments · Fixed by #6642
Closed
2 tasks

Fix broken update-imported-docs.sh #4283

ahmetb opened this issue Jul 5, 2017 · 16 comments · Fixed by #6642
Assignees
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@ahmetb
Copy link
Member

ahmetb commented Jul 5, 2017

It's not clear whether anybody has ran the update-imported-docs.sh for the v1.7 release.

I just tried running it, a few things are broken:

  • 1. cp: cannot stat 'k8s/cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml': No such file or directory this is because we copy this file and not use anywhere else. we should remove this. → PR Remove link to the removed code in Kubernetes repo #4285.
  • 2. yes | cp -rf -- k8s/federation/docs/api-reference/ docs/federation/ fails with cd: docs/federation/api-reference: No such file or directory
    • it looks like we moved this to /docs/reference/federation path and not updated the script. It also appears that /docs/federation never existed(??)
    • it looks like if I fix the copypath in _data/overrides.yaml, this script creates a docs/reference/federation/api-reference directory, instead of copying things in api-reference to docs/reference/federation.

Will add more issues if I find them.

/cc: @pwittrock @chenopis

@chenopis
Copy link
Contributor

chenopis commented Jul 5, 2017

I think @mengqiy would know how to fix this.

@ahmetb
Copy link
Member Author

ahmetb commented Jul 5, 2017

It also appears like Phillip has ran the script successfully at #4193. I am not sure why the (2) didn't fail back then. Also not sure why that patch didn't fix #4253.

@ahmetb
Copy link
Member Author

ahmetb commented Jul 5, 2017

I poked at this quite a bit still can't fix the docs/federation/api-reference issue.

I ended up deleting that dir altogether since it is not versioned anyway, the script completed successfully however:

  • the output is not correct
  • it added ---\n---\n to existing files. that doesn't sound right.

I'll probably be spending a few more hours on this with no good reason (this script takes 4 minutes to run every time) so I'll call help. @mengqiy can you help out? Maybe we should replace this script with something more manageable like python/go.

@mengqiy
Copy link
Member

mengqiy commented Jul 6, 2017

It also appears like Phillip has ran the script successfully at #4193.

That PR is updating the new style doc e.g. https://kubernetes.io/docs/api-reference/v1.7. It is generated by https://github.com/kubernetes-incubator/reference-docs

it added ---\n---\n to existing files.

It happened last time as well. I manually delete those lines, since there are not too many and I don't have enough time to debug it.

Maybe we should replace this script with something more manageable like python/go.

Sound good. I will vote for python. I can help review it.

@mengqiy
Copy link
Member

mengqiy commented Jul 6, 2017

Any update?
Is the imported doc up-to-date?

@ahmetb
Copy link
Member Author

ahmetb commented Jul 6, 2017

@mengqiy Nope, currently we don't know why

  1. the script breaks for Federation API reference
  2. why it didn't update docs/user-guide/kubectl/index.md (see Update kubectl cli from 1.6 to 1.7 #4253)

I appreciate if you can take a look.

@mengqiy
Copy link
Member

mengqiy commented Jul 6, 2017

Sure. Looking.

@mengqiy
Copy link
Member

mengqiy commented Jul 7, 2017

After digging a bit,

  1. the script breaks for Federation API reference

Structure in https://github.com/kubernetes/kubernetes.github.io/tree/master/docs/reference/federation and https://github.com/kubernetes/kubernetes/tree/master/federation/docs/api-reference are different. I will pull federation in for help. @nikhiljindal @madhusudancs

  1. why it didn't update docs/user-guide/kubectl/index.md

That doc doesn't exist in upstream any more. So the script doesn't update it.
And there is no link going to it. I think maybe we can delete it. https://kubernetes.io/docs/user-guide/kubectl/index.html

@nikhiljindal
Copy link
Contributor

it looks like we moved this to /docs/reference/federation path and not updated the script. It also appears that /docs/federation never existed(??)

Not sure when reference was added in the path, but I remember when I first added federation docs, I added them to /docs/federation so that dir did exist. Will try to dig up the PR.

@nikhiljindal
Copy link
Contributor

#1222 is the PR.

We were copying autogenerated federation docs from kubernetes/federation/docs/api-reference/ to kubernetes.github.io/docs/federation/ and it used to work fine.

Any idea when did we add reference in the path?
Just updating those paths to include reference should fix the problem?

@mengqiy
Copy link
Member

mengqiy commented Jul 15, 2017

I think we can stop maintaining update-imported-docs.sh, but write a python version instead after #4354 merged.

@chenopis
Copy link
Contributor

@mengqiy Is the Python version in the works? Are we keeping this issue open still?

@mengqiy
Copy link
Member

mengqiy commented Jul 28, 2017

I don't have bandwidth at this time.
@ahmetb Are you working the python or go version?

@ahmetb
Copy link
Member Author

ahmetb commented Jul 28, 2017

I am not working on this right now either, we can still keep patching it with fixes to federation issues. I am not sure how they're fixed for the 1.7 release.

@chenopis
Copy link
Contributor

We really need to sit down together and figure out a long term plan and who owns what. I'm still a little foggy on everything. :(

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

Prevent issues from auto-closing with an /lifecycle frozen comment.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or @fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants