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

Added additional support for git documentation sources #71

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

sei-mpriest
Copy link
Collaborator

@sei-mpriest sei-mpriest commented Oct 17, 2024

This PR adds some improvements for the handling of mkdocs materials when using git as a source for the docs. The changes are summarized as follows:

  1. Allows the use of the existing persistent volume claim for both the cronjob and the init containers of the deployment when running using git
  2. Supports overriding the site_url of the mkdocs.yml file when the deployment is served at a different host than the git repo specifies in the site_url field
  3. Supports overriding the path that nginx uses to redirect traffic to the static website to match the value specified in site_dir rather than the default value of "site"
  4. Supports providing git credentials as a secret in the format used by the git store credential helper

Note:
Because this PR configures git to use the store git credential helper, but the config file is read-only, we see this error in the init container logs every time git tries to write the creds:

fatal: unable to get credential storage lock in 1000 ms: Read-only file system

This error does not impact the functionality because the credentials did not actually change and the read of the credentials works properly. This could be fixed by using a custom git credential helper, but that would require some additional development. Is it ok to leave the current implementation given that error in the logs or should we fix it?

@sei-mkaar
Copy link
Contributor

@sei-mpriest Nice! 👍

And I agree about adding git https auth to this PR.

@sei-mpriest sei-mpriest marked this pull request as draft October 18, 2024 13:22
@sei-mpriest
Copy link
Collaborator Author

Marked as draft pending the git creds change.

@sei-mpriest sei-mpriest changed the title Add ability to use existing pvc for cronjob Added additional support for git documentation sources Oct 23, 2024
@sei-mpriest sei-mpriest marked this pull request as ready for review October 23, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants