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

Docs improvements #4863

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

Conversation

sznowicki
Copy link

As signalled over Matrix I prepared some docs changes that I believe would make me less confused during my initial setups where I wanted to have two agents: docker and local and pick the proper one per pipeline jobs.

On top added some references here and there in places where I felt confused as well, while not being that experienced with linux installation process and systemd setups.

Thanks again for help yesterday!

@xoxys
Copy link
Member

xoxys commented Feb 17, 2025

Thanks! After looking into this, I have the feeling we should refactor the installation guide at all. The added installation instructions are not specific for the local backend and should be part of the installation instructions for package-based installations. However, this docs part is pretty messy, there is only a section for third party packages while DEB and RPM packages are officially supported...

@xoxys xoxys added the documentation docu & docs label Feb 17, 2025
@qwerty287
Copy link
Contributor

qwerty287 commented Feb 17, 2025

I agree to @xoxys - thanks for the contribution, but this is not the right place and the whole part needs rewriting. The issue with the direct binary installation is also tracked in #1292

Besides that, it is not necessary to separately build the plugins. You can just run pnpm build in the docs repo and this builds the plugins as well.

@xoxys
Copy link
Member

xoxys commented Feb 17, 2025

Ill try to schedule some time this week to refactor the admin docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation docu & docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants