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

Non funcational local documention server #1030

Closed
th31nitiate opened this issue Aug 31, 2023 · 4 comments
Closed

Non funcational local documention server #1030

th31nitiate opened this issue Aug 31, 2023 · 4 comments

Comments

@th31nitiate
Copy link
Contributor

Describe the bug/feature
The docker container seems to have issue regarding how mkdocs is configured to be used with kapitan. This is mainly for local development.

To Reproduce
Run make local_server_documention. This causes an error. One which that that the pwd command is in all capitalized. This should not be the situation as Linux is case sensitive.

The second is the mode that mkdocs is run in. As it is configured to run ins strict mode. It is not possible launch the server. Looking at the docs the server does not seem to be a way configure this using environment variables. Unless we use cli arguments ?

The cli parameter of interest would be dev_addr. I am not entirely sure how important the mkdocs.yml config file is. If it is relevant to production deployments.

Expected behavior
upon running the command make local_server_documention the site should be viewable at localhost:8000

Additional context
I am more than willing to submit a pull request to fix the issue.

@MatteoVoges
Copy link
Contributor

Yeah, this is a known issue. My fix was to remove the strict: true at the beginning of mkdocs.yml.
Hope this helps...

@th31nitiate
Copy link
Contributor Author

Yes, I just set it to false also but I was wondering if it should be patched in the main branch.

How about the issue with the PWD variable. Did you experience this aswell ?

@MatteoVoges
Copy link
Contributor

I was wondering if it should be patched in the main branch.

There is a comment in #991 regarding this. I have no opinion about changing it, because I don't see any reasons, why we should fail at warnings when deploying the docs.

How about the issue with the PWD variable. Did you experience this aswell ?

Unfortunately not. Can you share the error message?

@MatteoVoges
Copy link
Contributor

The PR is merged now, so the instructions to start the local docs, should be fine. Let me know, if there is still something to do here!

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

No branches or pull requests

2 participants