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

Add a dockerfile, instructions to run mkdocs locally + in podman/docker #146

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

jasonmadigan
Copy link
Member

@jasonmadigan jasonmadigan commented Nov 12, 2024

Python environment setup and dependencies can be difficult to manage for those who want to dip and out of docs. Added an option to run mike/mkdocs in a container.

@openshift-ci openshift-ci bot requested review from maleck13 and roivaz November 12, 2024 16:31
Copy link
Contributor

openshift-ci bot commented Nov 12, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jasonmadigan

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

Copy link

netlify bot commented Nov 12, 2024

Deploy Preview for graceful-kangaroo-3c9c10 ready!

Name Link
🔨 Latest commit b655766
🔍 Latest deploy log https://app.netlify.com/sites/graceful-kangaroo-3c9c10/deploys/6733833f7119a100087b3552
😎 Deploy Preview https://deploy-preview-146--graceful-kangaroo-3c9c10.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jasonmadigan
Copy link
Member Author

cc @maleck13

mkdocs-material==9.5.14
mike==2.1.0
mkdocs-multirepo-plugin==0.8.3
mkdocs==1.6.1
Copy link
Member Author

Choose a reason for hiding this comment

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

mkdocs rev to remove warning about binding to 0.0.0.0 - without, we'd not be able to run mkdocs strict builds (to catch broken links etc)

Copy link
Contributor

@maleck13 maleck13 left a comment

Choose a reason for hiding this comment

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

This looks great. Will give it a try in the morning

@jasonmadigan jasonmadigan merged commit 3706178 into main Nov 22, 2024
8 of 9 checks passed
@jasonmadigan jasonmadigan deleted the dockerfile branch November 22, 2024 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants