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

Place link to documentation "Running locally in a conda environment" in a more easily-noticeable location #232

Closed
twallema opened this issue Jun 11, 2024 · 1 comment
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. duplicate This issue or pull request already exists. installation Relating to installation / upgrade / migration. low priority Low priority.

Comments

@twallema
Copy link
Member

  • I mainly used the Running locally in a conda environment tutorial to install flepiMop. However, I've never used Docker before, and because the flepiMoP/README.md immediately points to Docker I started by installing Docker, only to find out I could use my preferred method of collaborating on code (git cloning, setting up conda, run code) after going through the Docker installation.

  • I suggest pointing new collaborators ASAP to the quick-start-guide.md or quick-start-guide-conda.md by including a link in the main flepiMoP/README.md.

  • Or alternatively, if Docker is usefull to outsiders just wanting to use the code, include a "for users" section pointing to Docker and a "for collaborators" section pointing to conda.

  • The quick-start-guide.md and quick-start-guide-conda.md are actually very similar now that I'm comparing them, I suggest merging them into one quick start guide, which is the first thing a new user sees.

@twallema twallema added documentation Relating to ReadMEs / gitbook / vignettes / etc. enhancement Request for improvement or addition of new feature(s). labels Jun 11, 2024
@pearsonca pearsonca added installation Relating to installation / upgrade / migration. docstring Relating to in-code documentation. documentation Relating to ReadMEs / gitbook / vignettes / etc. and removed documentation Relating to ReadMEs / gitbook / vignettes / etc. enhancement Request for improvement or addition of new feature(s). docstring Relating to in-code documentation. labels Sep 13, 2024
@TimothyWillard TimothyWillard added this to the Under 1Hr New Users! milestone Nov 18, 2024
@TimothyWillard
Copy link
Contributor

Closing, I think this is now superseded by GH-401.

@TimothyWillard TimothyWillard added duplicate This issue or pull request already exists. low priority Low priority. labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. duplicate This issue or pull request already exists. installation Relating to installation / upgrade / migration. low priority Low priority.
Projects
None yet
Development

No branches or pull requests

3 participants