database setup documentation irritating

Open Beginner friendly
#534 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
postgresql
Domain
documentation

Research direction

Open the Hydra manual section linked in the issue and locate the database setup text about adding exports to ~/.profile. Update the wording so it tells readers to replace dbserver.example.org with the address of their PostgreSQL server while preserving the HYDRA_DBI and HYDRA_DATA examples. Done means the setup instruction is explicit about replacing the placeholder.

Written by the indexing model from the issue text.

Description

https://nixos.org/hydra/manual/#idm140737315956864

[...] add the following to the file ~/.profile of the user running the Hydra services.

export HYDRA_DBI="dbi:Pg:dbname=hydra;host=dbserver.example.org;user=hydra;"
export HYDRA_DATA=/var/lib/hydra

Maybe this can be changed to something like:

Add the following exports to your ~/.profile replacing dbserver.example.org with the address of your postgresql server

Dominant language
PLpgSQL
Stars
1.6k
Forks
358
Avg merge
20h 30m
Merged PRs (30d)
27

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NixOS/hydra

All issues in NixOS/hydra

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.