cms-dev / cms-dev/cms

Documentations

Open
#1,208 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc feature_request
Dominant language
Python
Stars
1k
Forks
412
Avg merge
6d 10h
Merged PRs (30d)
3

Description

Your documentation is very confusing for someone who wants to try this system for the first time.
I think you can separate the documentation for one server setup and multiserver setup.
a lot of the steps can be automated for first use or simple use.

I tried installing and using cms several times in different OSs.
first I tried it in kali Linux and I got a lot of bugs. each I fixed another came up so I decided to go test it in ubuntu 22.
that one was better than kali but still couldn't make it run.
so I uninstall ubuntu 22 and install ubuntu 18.
and I completely used your documentation for installing and using the cms server and still couldn't make it work.

please please please update your documentation.

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 reviewing the existing CMS installation and usage documentation for the single-server and multiserver setups, especially the Ubuntu and Kali Linux steps mentioned in the report. Done means the documentation is separated by setup type, first-use steps are simplified or automated where appropriate, and a fresh installation can follow the documented process successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux, python, ubuntu
Domain
devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.