-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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 scripts and tasks to publish docs to github pages #2430
Conversation
.travis/publish-docs.sh
Outdated
@@ -0,0 +1,42 @@ | |||
#!/usr/bin/env bash | |||
|
|||
# Copyright 2017 The Kubernetes Authors. |
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.
s/2017/2018
|
||
.PHONY: live-docs | ||
live-docs: | ||
@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs aledbf/mkdocs:0.1 |
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.
aledbf/mkdocs
What is this? Something custom?
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.
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.
I will create a repo for this image (I don't want to install mkdocs in my machine to test the docs or run a local copy)
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.
@ElvinEfendi repository of the mkdocs image https://github.com/aledbf/mkdocs
@@ -70,20 +71,24 @@ jobs: | |||
- stage: publish amd64 | |||
if: type = api AND branch = master AND repo = kubernetes/ingress-nginx | |||
script: | |||
- travis_wait ${TRAVIS_TIMEOUT} .travis/publish.sh amd64 | |||
- .travis/publish.sh amd64 |
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.
Who do we not need TRAVIS_TIMEOUT
anymore?
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.
This was required only for the s390x and ppc64le nginx images. Right now I am building that with an AWS VM
git config --global user.email "travis@travis-ci.com" | ||
git config --global user.name "Travis Bot" | ||
|
||
git clone --branch=gh-pages --depth=1 https://${GH_REF} ${DIR}/gh-pages |
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.
I'm curious to know why mkdocs gh-deploy
would not be a good fit here.
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.
I can change that but I found so many different ways that I choose this one. I can change this
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.
No need to, I haven't looked into the tool myself.
Codecov Report
@@ Coverage Diff @@
## master #2430 +/- ##
==========================================
+ Coverage 41.31% 41.44% +0.13%
==========================================
Files 74 74
Lines 5262 5262
==========================================
+ Hits 2174 2181 +7
+ Misses 2791 2785 -6
+ Partials 297 296 -1
Continue to review full report at Codecov.
|
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: aledbf, ElvinEfendi 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 |
No description provided.