-
-
Notifications
You must be signed in to change notification settings - Fork 284
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
Introduction should be crisp, needs re-ordering #1282
Comments
@beckermr @CJ-Wright @ocefpaf I agree we could enhance our introduction, any comments ? |
Go for it. Let's make prs and people will review them. :) |
This is the right approach to this problem. Thanks @ForgottenProgramme. The question you are raising are surprisingly not that easy to answer though! We have our heads buried in conda-forge for a few years and it is hard for us to see those problems clearly and writing something better. With that said... Let's track those questions here and, if you can, link them to "bite-size" PRs. You don't need to a address them all now. (I believe outreachy did not start yet, right?) |
@ocefpaf, hey! :) Right. Smaller PRs for each 'part' of this issue should be a good idea. |
Hey, Can I work on it as an Outrechy contribution? |
I was speculating the introduction page of Conda-forge, and what I contemplated was: As @ForgottenProgramme told that these lines "Missing a package that you would love to install with conda? " are not needed in the "what is conda-forge" we can add these lines in "why conda-forge?" What if we don't use the question mark for every subtitle, in the introduction page, because that seems like a FAQ section . |
Hello, First, when i opened the introduction page in the docs: (As my first time here) I read the opening section titled, 'What is conda-forge?'. So, i support that What is Conda- forge is suppose to be a complete definition of Conda-Forge (example; Conda-forge is a package for a wide range of software such as.........etc. Secondly, Missing a package that you would love to install with conda? - Chances are we have already packaged it for you! P So, i support that "All these pieces of information somehow seem disconnected. There is a lack of flow within the introduction." Thirdly, You can search for packages online. Look out for packages provided by our conda-forge organization. So, i support that what this is trying to convey is not immediately clear. Infact, these two sentence even seem disconnected. Thank you for this opportunity to contribute. |
@viniciusdc , Can I work on this? i am an Outreachy applicant. Please assign me! |
Hi, this issue is currently open for discussion. So it has not been assigned to anyone. But you can post your thoughts and carry forward the discussion which could be beneficial in reforming the intro. :) |
Hi! |
@ForgottenProgramme @viniciusdc I am an Outreachy applicant, looking forward to start my first contribution with this good first issue, as this issue is currently open and has not been assigned to anyone.I would love to work on this issue so please kindly assign me this issue. |
The introduction page in the docs:
https://conda-forge.org/docs/user/introduction.html#what-is-conda-forge
The opening section is titled, 'What is conda-forge?'.
It is followed by:
For me, as a new user, this line was not immediately very clear.
Am I missing a package that I would love to install with 'conda'? What does it mean? Does it mean 'is there a package I want to install using
conda install
only, but I'm unable to find it on the default conda channel' ? [I could reach this understanding only after some discussion with @viniciusdc .]Chances are conda-forge has already packaged it for me.
But so might have many other channels. Why should I use conda-forge?
[The answer to that question comes in the next section. 'Why conda-forge?' The flow is hence broken. ]
Again, what this is trying to convey is not immediately clear. Infact, these two sentence even seem disconnected.
[ A better alternative could be, 'Search for packages on anaconda.org and look for the ones with conda-forge as owner'. ]
But why?
Why is this information given under 'What's conda-forge?'
All these pieces of information somehow seem disconnected. There is a lack of flow within the introduction.
Suggested solution:
I think, we need to re-order and re-organize 'what goes under which heading'.
'What is conda-forge?' should only contain a proper definition of conda-forge.
This should then be followed by the 'Why conda-forge?' section, because after understanding that conda-forge is a channel that provides packages, the question that comes to mind is 'why should I use conda-forge over anything else?'
After that we tell the user how to check if a package they are looking for is available on conda-forge channel or not.
We then say,
The text was updated successfully, but these errors were encountered: