Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Node documentation.

Open
#6 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
docker, docker-compose
Domain
devops, documentation

Research direction

Start by reviewing the current deployment script and any existing Docker or docker-compose references in the repository. Document the direct Docker deployment commands, relevant flags, version or chainspec behavior, and the script's role as a secondary option; done means operators can deploy without inspecting the script.

Written by the indexing model from the issue text.

Description

Did you read the documentation and guides?
  • I have inspected the documentation.
Is there an existing issue?
  • I have searched the existing issues.
Description of the problem

Aleph node needed to have documentation on details around docker deployment. If proper documentation exists, everyone can deploy according to their needs and have a better experience in general through updates and everything since if they add some extra flag, they would know why they added it.

At the current state, script changes some files, mostly that's pulling chainspec file and rarely making other adjustments. There are more reliable ways to do this than script. Not to mention one of our servers 10.2 not recognized as an update, so the script updated the directory but kept pulling 10.1 instead of 10.2. Anyone could miss that and assume it's updated. This is problematic, considering the network might have problems and a fast response is required. Typically something like docker run aleph 10.1 --some flags command or directly latest tag here on docker-compose. We use the script, and when issues like this happen, we need to go through the script's code see what exactly sends as a command to fix the problem etc. If documentation exists, everyone can do their deployment and streamline their deployment process without relying on an unreliable scrip that could fail for various reasons.

Information on your setup.

While issue is with script I open this issue to make script a secondary option for docker deployments.

Steps to reproduce

No response

Did you attach relevant logs?
  • I have attached logs (if relevant).
Dominant language
No language data
Stars
2
Forks
0
No merged PRs in 30d

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.

More from Cardinal-Cryptography/aleph-node-issues

All issues in Cardinal-Cryptography/aleph-node-issues

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.