Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Improved development installation instructions order #278

Closed
wants to merge 2 commits into from
Closed

[docs] Improved development installation instructions order #278

wants to merge 2 commits into from

Conversation

praptisharma28
Copy link
Member

@praptisharma28 praptisharma28 commented Nov 9, 2024 •
edited
Loading

Checklist

  • I have read the OpenWISP Contributing Guidelines.
  • I have manually tested the changes proposed in this pull request.
  • I have written new test cases for new code and/or updated existing tests for changes to existing code.
  • I have updated the documentation.

Description of Changes

The changes make the installation process more straightforward by:

  1. Showing the big picture (directory structure) before details
  2. Ensuring proper package isolation through correct virtualenv setup
  3. Following Python best practices for development environments

pandafy
pandafy requested changes Nov 11, 2024
View reviewed changes
Copy link
Member

@pandafy pandafy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@praptisharma28 I would just make the instructions consistent with other modules.

You can use the openwisp-controller for reference.

https://github.com/openwisp/openwisp-controller/blob/master/docs/developer/installation.rst

praptisharma28
praptisharma28 commented Nov 12, 2024
View reviewed changes
docs/developer/installation.rst
Comment on lines +40 to +42
openwisp/ # Main project folder
├── env/ # Virtual environment
└── openwisp-firmware-upgrader/ # Cloned repository
Copy link
Member Author

@praptisharma28 praptisharma28 Nov 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it not needed then?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is not needed.

@nemesifier
Copy link
Member

This PR has overwritten a branch which we use for storing images and GIFs shown in the docs and website.
Please do not overwrite the docs branch. I am closing this PR so we can restore the original content. Please open a PR against master.

@nemesifier nemesifier closed this Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pandafy pandafy pandafy requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@praptisharma28 @nemesifier @pandafy