Skip to content

add gh-action to deploy mkdocs to gh-pages#3557

Merged
knative-prow-robot merged 3 commits into
knative:mkdocsfrom
csantanapr:issue-3542-gh-pages
May 12, 2021
Merged

add gh-action to deploy mkdocs to gh-pages#3557
knative-prow-robot merged 3 commits into
knative:mkdocsfrom
csantanapr:issue-3542-gh-pages

Conversation

@csantanapr
Copy link
Copy Markdown
Member

@csantanapr csantanapr commented May 12, 2021

Closes #3542

  • Add github action to publish mkdocs site to gh-pages branch
  • Add hack script for local livereload for mkdocs under /hack/docker

After this gets merge, someone with admin access to the docs repo needs to go to settings GH Pages and enable the branch gh-pages with / root
image

This also allows contributors to publish their mkdocs branch in their forks to be published in their own github.io namespace

@google-cla google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label May 12, 2021
@knative-prow-robot knative-prow-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 12, 2021
@csantanapr csantanapr requested a review from julz May 12, 2021 03:42
@csantanapr
Copy link
Copy Markdown
Member Author

csantanapr commented May 12, 2021

/assign @julz

@csantanapr
Copy link
Copy Markdown
Member Author

csantanapr commented May 12, 2021

Once this lands we can work on getting the dns cname beta.knative.dev

julz
julz reviewed May 12, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@julz julz left a comment

Choose a reason for hiding this comment

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

Once #3558 lands we'll want to update some of this to use ./hack/build-with-blog.sh, but looks good for now apart from would be good to update the commit email/name I think.

Comment thread .github/workflows/knative-mkdocs.yaml Outdated
- name: Setup doc deploy
run: |
git config --global user.name Docs deploy
git config --global user.email docs@dummy.bot.com
Copy link
Copy Markdown
Contributor

@julz julz May 12, 2021

Choose a reason for hiding this comment

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

wonder if we should use something like automation@knative.team here like some of the other actions do?

Copy link
Copy Markdown
Member Author

@csantanapr csantanapr May 12, 2021

Choose a reason for hiding this comment

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

I will update this, what do they use for user.name ?

Copy link
Copy Markdown
Member Author

@csantanapr csantanapr May 12, 2021

Choose a reason for hiding this comment

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

found it Knative Automation

csantanapr added 2 commits May 12, 2021 12:39
@csantanapr
update commit user for gh-pages
48be21f 
Signed-off-by: Carlos Santana <csantana23@gmail.com>
@csantanapr
switch to fast livereload
5f487b7 
Signed-off-by: Carlos Santana <csantana23@gmail.com>
julz
julz reviewed May 12, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@julz julz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

/lgtm

we should create a follow-on issue to swap the action to use ./hack/build-with-blog.sh so we get the whole site built with blog and community (we'll figure out versioning after that)

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label May 12, 2021
@csantanapr
Copy link
Copy Markdown
Member Author

csantanapr commented May 12, 2021

/assign @omerbensaadon

@omerbensaadon omerbensaadon added kind/mkdocs approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 12, 2021
@knative-prow-robot
Copy link
Copy Markdown
Contributor

knative-prow-robot commented May 12, 2021

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: julz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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

@knative-prow-robot knative-prow-robot merged commit 5e9b402 into knative:mkdocs May 12, 2021
@omerbensaadon omerbensaadon mentioned this pull request May 13, 2021
Closed
RichardJJG pushed a commit to RichardJJG/docs that referenced this pull request Jun 30, 2021
@csantanapr @RichardJJG
add gh-action to deploy mkdocs to gh-pages (knative#3557)
6c65a98 
* add gh-action to deploy mkdocs to gh-pages

* update commit user for gh-pages

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* switch to fast livereload

Signed-off-by: Carlos Santana <csantana23@gmail.com>
RichardJJG pushed a commit to RichardJJG/docs that referenced this pull request Jul 1, 2021
@csantanapr @RichardJJG
add gh-action to deploy mkdocs to gh-pages (knative#3557)
c3e79a5 
* add gh-action to deploy mkdocs to gh-pages

* update commit user for gh-pages

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* switch to fast livereload

Signed-off-by: Carlos Santana <csantana23@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@julz julz julz approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@julz julz

@omerbensaadon omerbensaadon

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. kind/mkdocs lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@csantanapr @knative-prow-robot @julz @omerbensaadon