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

Import kubernetes/community docs #6863

Merged
merged 19 commits into from
Jan 11, 2018
Merged

Import kubernetes/community docs #6863

merged 19 commits into from
Jan 11, 2018

Conversation

chenopis
Copy link
Contributor

@chenopis chenopis commented Jan 6, 2018 •
edited
Loading

This PR generalizes the /update-imported-docs/update-imported-docs.go script to import files from any arbitrary repo. For example, the PR introduces a community.yml file which imports 4 files from the kubernetes/community repo into the /imported/community/ directory.

Major changes:

  1. Use compiled binary instead of go run update-imported-docs.go so that the script properly sets the base directory of the website regardless of where it is executed from.
  2. Take a command line argument to specify which config.yml file to use.
  3. Change the generate command, e.g. hack/generate-docs.sh, into an optional entry in the YAML file.
  4. Display the running output of the generate command in case there are any messages or errors.
  5. Add code comments for readability.
  6. Improve output format for readability.

NOTE: Any new documents imported into the repo will need to be added to the /_data/imported.yml ToC file or else Travis CI will fail.

This change is Reviewable

@chenopis chenopis self-assigned this Jan 6, 2018
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 6, 2018
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Jan 6, 2018 •
edited
Loading

Deploy preview ready!

Built with commit 563f693

https://deploy-preview-6863--kubernetes-io-master-staging.netlify.com

@tengqm
Copy link
Contributor

tengqm commented Jan 6, 2018

CI failure is real.

@chenopis
Copy link
Contributor Author

chenopis commented Jan 8, 2018 •
edited
Loading

Previews are:
https://deploy-preview-6863--kubernetes-io-master-staging.netlify.com/docs/imported/

https://deploy-preview-6863--kubernetes-io-master-staging.netlify.com/docs/imported/community/devel/

https://deploy-preview-6863--kubernetes-io-master-staging.netlify.com/docs/imported/community/guide/

https://deploy-preview-6863--kubernetes-io-master-staging.netlify.com/docs/imported/community/mentoring/

https://deploy-preview-6863--kubernetes-io-master-staging.netlify.com/docs/imported/community/keps/

@chenopis
Copy link
Contributor Author

chenopis commented Jan 8, 2018 •
edited
Loading

FYI, Travis is failing because I need to create a ToC for these docs.

@chenopis chenopis changed the title Import kubernetes/community docs [WIP] Import kubernetes/community docs Jan 8, 2018
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 8, 2018
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 8, 2018
@chenopis chenopis force-pushed the chenopis-import-repos branch from be92fd9 to a6df212 Compare January 8, 2018 17:36
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 8, 2018
@chenopis chenopis changed the title [WIP] Import kubernetes/community docs Import kubernetes/community docs Jan 9, 2018
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 9, 2018
@chenopis
Copy link
Contributor Author

chenopis commented Jan 9, 2018

@steveperry-53 The changes are done and tested. I decided to just modify the original update-imported-docs.go script because I found a straightforward way to generalize it. PTAL

@chenopis chenopis force-pushed the chenopis-import-repos branch from 51df236 to ef1c44d Compare January 9, 2018 04:15
@tengqm tengqm closed this Jan 9, 2018
@tengqm tengqm reopened this Jan 9, 2018
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 9, 2018
@chenopis chenopis force-pushed the chenopis-import-repos branch from a5d7bcf to 8f2bfd9 Compare January 9, 2018 08:24
@chenopis
Copy link
Contributor Author

chenopis commented Jan 9, 2018

@steveperry-53 @castrojo This should be good to go. PTAL

@chenopis
Copy link
Contributor Author

chenopis commented Jan 9, 2018

/cc @zacharysarah

@steveperry-53
Copy link
Contributor

@chenopis I'm reviewing now. I'll have feedback by the end of the day.

steveperry-53
steveperry-53 reviewed Jan 9, 2018
View reviewed changes
docs/imported/community/guide.md Outdated
## Sign the CLA

Before you can contribute, you will need to sign the [Contributor License Agreement](/CLA.md).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the content is imported to kubernetes.io, there are a lot of broken links. It's because of relative link targets like (/CLA.md).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be encouraging full URL links in the community repo?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abiogenesis-now is going to add in code to rewrite the URLs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR is here #6926

@steveperry-53
Copy link
Contributor

@chenopis This looks great. After you merge this, I'll test the new code on the ref docs and update #6366.

Jessica Yao and others added 2 commits January 10, 2018 15:40
@chenopis chenopis merged commit a95ca06 into master Jan 11, 2018
@chenopis chenopis deleted the chenopis-import-repos branch January 11, 2018 04:03
@chenopis
Copy link
Contributor Author

Thanks @abiogenesis-now !

@steveperry-53 @castrojo This is now out the door! =)

chenopis added a commit that referenced this pull request Jan 11, 2018
@chenopis
Merge branch 'master' of https://github.com/kubernetes/website into c…
146eabd 
…henopis-user-journeys

* 'master' of https://github.com/kubernetes/website:
  Import kubernetes/community docs (#6863)
  Update conventions.md
  Update troubleshooting-kubeadm.md
  Update troubleshooting-kubeadm.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@steveperry-53 steveperry-53 steveperry-53 left review comments

@jesscodez jesscodez jesscodez left review comments

@tengqm tengqm tengqm approved these changes

@castrojo castrojo Awaiting requested review from castrojo

@zacharysarah zacharysarah Awaiting requested review from zacharysarah

Assignees

@chenopis chenopis

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@chenopis @k8sio-netlify-preview-bot @tengqm @steveperry-53 @castrojo @jesscodez @k8s-ci-robot