search

creativecommons / creativecommons.github.io-source

Source files for CC Open Source website
https://opensource.creativecommons.org/
MIT License
77 stars 174 forks source link

[Bug] The documentation is missing important commands and specific steps needed to run the necessary commands correctly. #820

Open Dev-JoyA opened 1 week ago

Dev-JoyA commented 1 week ago

Description

The documentation states that a Python environment must be created, but it lacks specific commands to guide users through this process. This absence of information can impede the development workflow, as users may struggle to set up their environment correctly.

Additionally, if Python 3.11 is not installed on a user's system (or if pipenv is unable to locate it), they might need to specify the Python path. However, the documentation does not currently address the necessary steps or alternatives if Python 3.11 is present instead.

Reproduction

  1. Open the open source repository.
  2. Go to the README file , find the Installing Project Requirements sub heading.
  3. There is a requirement to create python virtual environment, but the command is missing.

Expectation

I expected the documentation to provide clear and detailed commands for creating a Python environment, ensuring users could easily set it up. This clarity would help prevent confusion and ensure a smooth development process, allowing all team members to quickly get started with the project without facing setup issues.

Resolution

TimidRobot commented 1 week ago

https://github.com/creativecommons/creativecommons.github.io-source/labels/%E2%9B%94%EF%B8%8F%20status%3A%20discarded:

Dev-JoyA commented 1 week ago

@TimidRobot the command to create a virtual environment is this pipenv --python 3.12

Also there is need to know the version of python the user uses by running python --version

This two command is not included in the documentation and its a necessary step for installation

This command is for installing requirement for the project pipenv install --dev

and without this pipenv --python 3.12 it wont work

TimidRobot commented 1 week ago

@Dev-JoyA thank you for the additional information.

The Python version (3.11) is defined in the Pipefile.

If there's no Python 3.11 on your system (or if pipenv can't find it), you may need to specify the Python location. For example:

 pipenv install --dev --python /opt/homebrew/bin/python3.11

Adding a sub-bullet to the README might be helpful. Please update this issue description.