Skip to content

fix docs theme with latest mkdocs-material & pin docs dev environment #2023

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

Merged
merged 1 commit into from
May 20, 2021

Conversation

M00nF1sh
Copy link
Collaborator

description

  1. fix docs theme with latest mkdocs-material. (the latest v7.1.5 mkdocs-material have changes breaking current docs).
  2. pin docs dev environment by
    1. add pipenv for docs dependencies.
    2. add makefile targets for preview

usage

  1. Install pipenv. either by (python3 -m pip install pipenv or brew install pipenv)
  2. run make docs-preview to preview docs
  3. run make docs-publish to publish docs

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 20, 2021
@k8s-ci-robot k8s-ci-robot requested a review from kishorj May 20, 2021 01:01
@codecov-commenter
Copy link

Codecov Report

Merging #2023 (35ec0b8) into main (07a29df) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2023   +/-   ##
=======================================
  Coverage   49.24%   49.24%           
=======================================
  Files         130      130           
  Lines        7034     7034           
=======================================
  Hits         3464     3464           
  Misses       3292     3292           
  Partials      278      278           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 07a29df...35ec0b8. Read the comment docs.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kishorj, M00nF1sh

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kishorj
Copy link
Collaborator

kishorj commented May 20, 2021

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 20, 2021
@k8s-ci-robot k8s-ci-robot merged commit a8074f1 into kubernetes-sigs:main May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants