Skip to content

Update requirements.txt #780

Merged
Andriciuc merged 5 commits into17from
requirements.txt
Apr 10, 2025
Merged

Update requirements.txt #780
Andriciuc merged 5 commits into17from
requirements.txt

Conversation

@Andriciuc
Copy link
Copy Markdown
Contributor

To remove .txt mention in upgrade and removed freeze command

requirements.txt Outdated
# pip install --upgrade -r requirements.txt
# To freeze the current packages and their versions, run the following command in your terminal:
# pip freeze > requirements.txt
# pip install --upgrade -r <plugin_name>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why plugin name? When you pass the requirements.txt file, it installs all packages listed so you don't have to install them one by one

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah I should mention that this is specifically a rule if the user is using Windows, to get this to work through Powershell it will require more tweaking than it is worth.

I will update to mention both Linux and Windows procedures of using the list, what do you think?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes good idea

@nastena1606
Copy link
Copy Markdown
Contributor

I wouldn't split the instructions above and below the list. And maybe it's worth moving them to Contributing.md? We have a dedicated section: https://github.com/percona/postgresql-docs/blob/17/CONTRIBUTING.md#install-mkdocs-and-build-locally
It's unlikely someone will look into this file to figure out how to install a package.

@Andriciuc
Copy link
Copy Markdown
Contributor Author

Thank you @nastena1606, you're right! Mostly this change was for us but I will definitely check out the Contributing doc and add any observations there too!

Merged commands into a single flow.
Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
@nastena1606 nastena1606 temporarily deployed to requirements.txt - postgresql-docs-preview-17 PR #780 April 10, 2025 10:15 — with Render Destroyed
Commited all suggestions, thank you!

Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
@nastena1606 nastena1606 temporarily deployed to requirements.txt - postgresql-docs-preview-17 PR #780 April 10, 2025 10:15 — with Render Destroyed
@Andriciuc Andriciuc merged commit 53bc4bc into 17 Apr 10, 2025
1 check passed
Andriciuc added a commit that referenced this pull request Apr 15, 2025
* Update requirements.txt with commented procedures for our internal doc team.

Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
Andriciuc added a commit that referenced this pull request Apr 15, 2025
* Update requirements.txt with commented procedures for our internal doc team.

Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
Andriciuc added a commit that referenced this pull request Apr 15, 2025
* Update requirements.txt with commented procedures for our internal doc team.

Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
Andriciuc added a commit that referenced this pull request Apr 15, 2025
* Update requirements.txt with commented procedures for our internal doc team.

Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants