Skip to content

Commit db992f5

Browse files
Fix some typos
There was a broken link that I've replaced, not sure if I'm pointing at the right place.
1 parent 2bec0ed commit db992f5

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

docs/conda_integration.rst

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ The conda package manager makes installing software a vastly more streamlined pr
1818
Defining a Conda package
1919
-------------------------
2020

21-
The preferred way to build a conda package is to write a `conda recipe <https://conda.pydata.org>`_ and submit this it the BioConda communitiy. As soon as your PR is merged and continues integration testing was successful, we will build you automatically a container and publish it at `quay.io/biocontainers <https://quay.io/organization/biocontainers>`_ and `BioContainers Registry <http://biocontainers.pro/#/registry>`__.
21+
The preferred way to build a conda package is to write a `conda recipe <https://conda.pydata.org>`_ and submit this it the BioConda community. As soon as your PR is merged and continues integration testing was successful, we will build you automatically a container and publish it at `quay.io/biocontainers <https://quay.io/organization/biocontainers>`_ and `BioContainers Registry <http://biocontainers.pro/#/registry>`__.
2222

23-
The BioConda specification `Contribution Guide <https://bioconda.github.io/contributing.html>`_ define how to create a recipe. In summary, a BioConda recipe should contain the following parts ():
23+
The BioConda specification `Contribution Guide <https://bioconda.github.io/contributing.html>`_ define how to create a recipe. In summary, a BioConda recipe should contain the following parts:
2424

2525
- Source URL is stable (details)
2626
- md5 or sha256 hash included for source download (details)
@@ -33,7 +33,7 @@ The BioConda specification `Contribution Guide <https://bioconda.github.io/contr
3333
- Package does not already exist in the defaults, r, or conda-forge channels with some
3434
exceptions (details)
3535
- Package is appropriate for bioconda
36-
- If the recipe installs custom wrapper scripts, usage notes should be added to ``extra -> notes`` in the meta.yaml.
36+
- If the recipe installs custom wrapper scripts, usage notes should be added to ``extra -> notes`` in the meta.yaml
3737

3838
Example Yaml for bowtie2:
3939

@@ -82,13 +82,13 @@ Example Yaml for bowtie2:
8282
license_file: LICENSE
8383
summary: 'Hybrid assembly pipeline for bacterial genomes'
8484
85-
When the recipe is ready a Pull Request should be created (https://bioconda.github.io/contribute-a-recipe.html#push-changes-wait-for-tests-to-pass-submit-pull-request). Finally, the container is automatically created for the new BioConda Package.
85+
When the recipe is ready, a Pull Request should be created (https://bioconda.github.io/contributor/workflow.html). Finally, the container is automatically created for the new BioConda Package.
8686

8787

8888
Automatic build from conda recipes
8989
-----------------------------------
9090

91-
We utilize `mulled <https://github.com/mulled/mulled>`_ with `involucro <https://github.com/involucro/involucro>`_ in an automatic way. This is for example used to convert all packages in ``bioconda`` into Linux Containers (Docker and rkt at the moment. We have developed small utilities around this technology stack which is currently included in galaxy-lib.
91+
We utilize `mulled <https://github.com/mulled/mulled>`_ with `involucro <https://github.com/involucro/involucro>`_ in an automatic way. This is for example used to convert all packages in ``bioconda`` into Linux Containers (Docker and rkt at the moment). We have developed small utilities around this technology stack which is currently included in galaxy-lib.
9292

9393
.. code-block:: bash
9494
@@ -108,7 +108,7 @@ This will search for containers in the biocontainers organisation.
108108
Build all packages from bioconda from the last 24h
109109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110110

111-
The BioConda community is building a container for every package they create with a command similar to this.
111+
The BioConda community is building a container for every package they create with a command similar to this:
112112

113113
.. code-block:: bash
114114
@@ -119,27 +119,25 @@ The BioConda community is building a container for every package they create wit
119119
Building Docker containers for local Conda packages
120120
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121121

122-
Conda packages can be tested with creating a busybox based container for this particular package in the following way.
122+
Conda packages can be tested with creating a busybox-based container for this particular package in the following way.
123123
This also demonstrates how you can build a container locally and on-the-fly.
124124

125-
..
125+
.. note:: We modified the samtools package to version 3.0 to make clear we are using a local version.
126126

127-
we modified the samtools package to version 3.0 to make clear we are using a local version
128127

129-
130-
1) build your recipe
128+
1) Build your recipe
131129

132130
.. code-block:: bash
133131
134132
$ conda build recipes/samtools
135133
136-
2) index your local builds
134+
2) Index your local builds
137135

138136
.. code-block:: bash
139137
140138
$ conda index /home/bag/miniconda2/conda-bld/linux-64/
141139
142-
3) build a container for your local package
140+
3) Build a container for your local package
143141

144142
.. code-block:: bash
145143
@@ -154,8 +152,7 @@ Build, test and push a conda-forge package to biocontainers
154152

155153
.. note:: You need to have write access to the biocontainers repository
156154

157-
You can build packages from other Conda channels as well, not only from BioConda. ``pandoc`` is available from the conda-forge channel and conda-forge is also enabled by default in Galaxy. To build ``pandoc`` and push it to biocontainrs
158-
you could do something along these lines.
155+
You can build packages from other Conda channels as well, not only from BioConda. ``pandoc`` is available from the conda-forge channel and conda-forge is also enabled by default in Galaxy. To build ``pandoc`` and push it to BioContainers, you could do something along these lines:
159156

160157
.. code-block:: bash
161158
@@ -166,7 +163,7 @@ you could do something along these lines.
166163
167164
* Galaxy Conda documentation: ./conda_faq.rst
168165
* IUC: https://wiki.galaxyproject.org/IUC
169-
* container annotation: https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/catDocker.xml#L4
166+
* Container annotation: https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/catDocker.xml#L4
170167
* BioContainers: https://github.com/biocontainers
171168
* bioconda: https://github.com/bioconda/bioconda-recipes
172169
* BioContainers Quay.io account: https://quay.io/organization/biocontainers

0 commit comments

Comments
 (0)