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.

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

Improve information about conda in docs #427

Closed
abravalheri opened this issue Mar 11, 2021 · 3 comments
Closed

Improve information about conda in docs #427

abravalheri opened this issue Mar 11, 2021 · 3 comments
Assignees
Labels
documentation Improvements, additions and corrections to documentation enhancement New feature or request
Milestone

Comments

@abravalheri
Copy link
Collaborator

abravalheri commented Mar 11, 2021

Currently we have this information available about conda.
According to @maresb review on #424:

A potential problem I see is that "Creating Conda Packages" is a very niche topic which 99% of users will probably never do. But using conda in conjunction with PyScaffold in particular dsproject is a very important mainstream theme. This niche topic is now very prominent in the PyScaffold documentation, while (as far as I can tell) there isn't really a prominent explanation of using conda in general. I think this gives the wrong impression about what conda is mainly for. I wonder if it would be better to:

  • rename the topic "Creating Conda Packages" → "Using Conda Packages",
  • describe using conda as a package manager, the environment.yml file, etc, and
  • put this section which you just wrote at the end.

Those are really great suggestions that would be nice to adopt.

Hopefully we can borrow some of the previous writings from @FlorianWilhelm on #368 and #426 to compose the extra sections.

Additionally this section should be at least linked to Dependency Management (should we keep them 2 separated sections or put conda under the Dependency Management? but then talking about how to create conda packages seem a bit weird... not sure how to organise everything in a cohesive way).

@abravalheri abravalheri added enhancement New feature or request documentation Improvements, additions and corrections to documentation labels Mar 11, 2021
@FlorianWilhelm FlorianWilhelm added this to the 4.0.2 milestone May 16, 2021
@FlorianWilhelm FlorianWilhelm self-assigned this May 16, 2021
@FlorianWilhelm
Copy link
Member

I'll look into that. I like the idea of putting it into the dependency management section and describe how to use conda instead of creating an own conda package. I'll work on a proposal PR.

@abravalheri
Copy link
Collaborator Author

Thank you very much @FlorianWilhelm

@FlorianWilhelm
Copy link
Member

This was fixed in #446.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements, additions and corrections to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants