nextcloud / nextcloud/nextcloud-docker-dev

Enhance documentation for initial setup

Open
#375 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
PHP
Stars
190
Forks
103
Avg merge
4h 36m
Merged PRs (30d)
1

Description

Being struggling for 2 days in building the repository, I would suggest to enhance install documentation.

Main issue is repetitive "fetch-pack: unexpected disconnect while reading sideband packet" during git clone.
Either to load initial https://github.com/juliusknorr/nextcloud-docker-dev. Or when running bootstrap script.

Documentation should make it more clear that the steps:
git config --global core.compression 0
git clone --depth 1 https://github.com/juliusknorr/nextcloud-docker-dev
git fetch --unshallow

Recommand to make backup copy nextcloud-docker-dev
cp -r nextcloud-docker-dev nextcloud-docker-copy
before to run bootstrap script
This allow to restart without struggling again to download repository in case of failure during execution of bootstrap scrip.

Also the way to edit bootstrat script to make git clone safer. Or provide an alternate bootstrap script to make git clone safe

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.

Research direction

Start by locating the install documentation and the bootstrap script mentioned in the issue, then review how repository cloning currently works. Document the safer clone and backup steps, or clarify the bootstrap alternative, and verify that a failed setup can be restarted without downloading the repository again.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, git
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.