Skip to content

Commit 188c0d0

Browse files
committed
ENH add announcement and citation docs
1 parent ab01ac3 commit 188c0d0

File tree

2 files changed

+45
-11
lines changed

2 files changed

+45
-11
lines changed

src/user/announcements.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ Announcements
55

66
Our announcements are published to an RSS feed `here <https://conda-forge.org/docs/news.rss>`_.
77

8+
2021
9+
----
10+
11+
:2020-05-22: ``conda-forge`` is now citable!
12+
13+
You can now cite ``conda-forge`` using our `Zenodo entry <https://doi.org/10.5281/zenodo.4774216>`_!
14+
This entry credits the entire ``conda-forge`` community for its hard work in building our
15+
amazing ecosystem.
16+
817
2020
918
----
1019

src/user/introduction.rst

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This came with a list of disadvantages:
3030

3131
- Locating packages was difficult due to them being scattered over many channels.
3232
- Combining packages across channels was not always possible due to binary incompatibilities.
33-
- Packages were only available for architectures the developer was interested in or had access to.
33+
- Packages were only available for architectures the developer was interested in or had access to.
3434
- Channels were often abandoned, updating required locating new channels.
3535

3636
conda-forge is a community effort that tackles these issues:
@@ -43,32 +43,30 @@ conda-forge is a community effort that tackles these issues:
4343
- An active core developer team is trying to also maintain abandoned packages.
4444

4545

46-
4746
How can I install packages from conda-forge?
4847
--------------------------------------------
4948

5049
Using conda-forge is easy!
5150

5251
- Make sure you have ``conda >=4.9``.
53-
52+
5453
.. code-block:: bash
5554
5655
conda --version
5756
conda update conda
58-
59-
- Add ``conda-forge`` as the highest priority channel.
60-
57+
58+
- Add ``conda-forge`` as the highest priority channel.
59+
6160
.. code-block:: bash
6261
6362
conda config --add channels conda-forge
64-
63+
6564
- Activate ``strict`` channel priority (``strict`` will be activated by default in conda 5.0).
66-
65+
6766
.. code-block:: bash
6867
6968
conda config --set channel_priority strict
7069
71-
7270
From now on using ``conda install <package-name>`` will also find packages in our conda-forge channels.
7371

7472
.. note::
@@ -82,7 +80,7 @@ From now on using ``conda install <package-name>`` will also find packages in ou
8280
.. note::
8381

8482
Please be aware that the order of your conda package channels is important, especially when you combine conda-forge with other channels, e.g. ``bioconda``.
85-
83+
8684
.. note::
8785

8886
`Miniforge <https://github.com/conda-forge/miniforge>`__ is a community
@@ -96,9 +94,36 @@ From now on using ``conda install <package-name>`` will also find packages in ou
9694
Please refer to :ref:`multiple_channels` for pitfalls and more information.
9795

9896

97+
How can I give credit to ``conda-forge``?
98+
-----------------------------------------
99+
100+
If you'd like to credit ``conda-forge`` in your work, please cite our `Zenodo entry <https://doi.org/10.5281/zenodo.4774216>`_. This citation is
101+
102+
::
103+
104+
conda-forge community. (2015). The conda-forge Project: Community-based
105+
Software Distribution Built on the conda Package Format and Ecosystem.
106+
Zenodo. http://doi.org/10.5281/zenodo.4774216
107+
108+
or in `bibtex` it is
109+
110+
::
111+
112+
@misc{conda_forge_community_2015_4774216,
113+
author = {conda-forge community},
114+
title = {{The conda-forge Project: Community-based Software
115+
Distribution Built on the conda Package Format and
116+
Ecosystem}},
117+
month = jul,
118+
year = 2015,
119+
publisher = {Zenodo},
120+
doi = {10.5281/zenodo.4774216},
121+
url = {https://doi.org/10.5281/zenodo.4774216}
122+
}
123+
99124

100125
Display conda-forge packages in Anaconda Navigator
101-
------------------------------------------------------------
126+
--------------------------------------------------
102127

103128
#. Open **Anaconda Navigator** by running ``anaconda-navigator``
104129
#. Go to the **Environments** tab.

0 commit comments

Comments
 (0)