Skip to content

Instructions for setting up docs dev environment is incomplete #19171

@nmasnadithya

Description

@nmasnadithya

Do you see an area that can be clarified or expanded, a technical inaccuracy, or a broken link?

make docs-install is not enough to setup the docs build environment in a fresh MacOS environment. make docs fails because it depends on uv and some other dependencies

Link

https://docs.goauthentik.io/developer-docs/docs/writing-documentation/

Solution

You can resolve this by following the instructions in Setting up full development environment, until make install.

Additional context

Not sure what other dependencies were causing the issue. I got stuck with uv & xmlsec, before I did the full make install.

Metadata

Metadata

Labels

area:docsFeatures or issues related to Docusaurusenhancement/confirmedEnhancements that will be implemented in the futureneeds_documentationQuestions/Issues that require additional documentation

Type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions