pterodactyl / pterodactyl/documentation

Document all environment variables

Open
#471 0 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Vue
Stars
198
Forks
2.2k
PR merge metrics
No merged PRs in 30d

Description

Currently a lot of the required and optional environment variables for the panel are not documented, it would be good to have a page providing information on all available variables.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the panel's required and optional environment variable definitions, then review the documentation structure to choose where the new page belongs. Document every available variable with enough information for users to understand it; done means the page covers both required and optional variables.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.