Skip to content

Commit bf696c2

Browse files
committed
standardize to lowercase, no-backticks by default
1 parent e167208 commit bf696c2

23 files changed

+196
-196
lines changed

src/contracting/00_intro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Contracting Information
22
#######################
33

4-
If you are interested in a contractual engagement to solve a specific problem that you're facing, this page details the kinds of services that are available to you. ``conda-forge``, as an entity, does not have the ability to engage in a contractual arrangement as of now.
4+
If you are interested in a contractual engagement to solve a specific problem that you're facing, this page details the kinds of services that are available to you. conda-forge, as an entity, does not have the ability to engage in a contractual arrangement as of now.
55
However, there are a number of community members that you may engage with.
6-
``conda-forge`` does not endorse anyone (individuals or companies) listed on this page.
6+
conda-forge does not endorse anyone (individuals or companies) listed on this page.
77

88

99
If you are interested in a service that is not listed on this page, please reach out to us on our `issue tracker <https://github.com/conda-forge/conda-forge.github.io/issues>`__, on `Element <https://app.element.io/#/room/#conda-forge:matrix.org>`__ or via emailing the core team directly at [email protected] and we will help to circulate your request more broadly within the community.
@@ -39,7 +39,7 @@ Background / Description: Quansight's goal is to create operational solutions to
3939
Becoming a Service Provider
4040
***************************
4141

42-
The ``conda-forge`` core team reserves the right to unilaterally update this list at any time for any reason.
42+
The conda-forge core team reserves the right to unilaterally update this list at any time for any reason.
4343
If you are a service provider and are interested in being added to this list please open up a pull request against the conda-forge.github.io repository.
4444
Add yourself to this list and detailing the services you provide.
4545
Please be brief and link to existing materials on your own website where possible.

src/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Chances are we have already packaged it for you. You can `search <https://anacon
1313

1414
**Cannot find a package or only outdated versions of a package?** - Everybody is welcome to contribute to our package stack!
1515

16-
- We value all kinds of contributions — not just code. A few recommended ways to start contributing to ``conda-forge`` are:
16+
- We value all kinds of contributions — not just code. A few recommended ways to start contributing to conda-forge are:
1717

1818
- `Contribute new packages <https://conda-forge.org/docs/maintainer/adding_pkgs.html>`__
1919
- Help update and `maintain packages <https://conda-forge.org/docs/maintainer/updating_pkgs.html#maintaining-pkgs>`__

src/maintainer/adding_pkgs.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Your final recipe should have no comments (unless they're actually relevant to t
5151

5252
.. note::
5353

54-
If there are any details you are not sure about please create a pull request anyway. The ``conda-forge`` team will review it and help you make changes to it.
54+
If there are any details you are not sure about please create a pull request anyway. The conda-forge team will review it and help you make changes to it.
5555

5656
In case you are building your first recipe using conda-forge, a step-by-step instruction and checklist that will help you with a successful build is provided below.
5757

@@ -96,7 +96,7 @@ Checklist
9696

9797
* Ensure that the license and license family descriptors (optional) have the right case and that the license is correct. Note that case sensitive inputs are required (e.g. Apache-2.0 rather than APACHE 2.0). Using SPDX identifiers for license field is recommended. (see :ref:`spdx`)
9898
* Ensure that you have included a license file if your license requires one -- most do. (see `here <https://github.com/conda-forge/staged-recipes/blob/a504af81c05491bf7b0b018b2fa1efe64767985c/recipes/example/meta.yaml#L52-L55>`_)
99-
* In case your project has tests included, you need to decide if these tests should be executed while building the ``conda-forge`` feedstock.
99+
* In case your project has tests included, you need to decide if these tests should be executed while building the conda-forge feedstock.
100100
* Make sure that all tests pass successfully at least on your development machine.
101101
* Recommended: run the test locally on your source code to ensure the recipe works locally (see :ref:`staging_test_locally`).
102102
* Make sure that your changes do not interfere with other recipes that are in the ``recipes`` folder (e.g. the ``example`` recipe).
@@ -121,7 +121,7 @@ Post staging process
121121

122122
* After the PR is merged, our :term:`CI` services will create a new git repo automatically. For example, the recipe for a package named ``pydstool`` will be moved to a new repository `https://github.com/conda-forge/pydstool-feedstock <https://github.com/conda-forge/pydstool-feedstock>`_. This process is automated through a CI job on the ``conda-forge/staged-recipes`` repo. It sometimes fails due to API rate limits and will automatically retry itself. If your feedstock has not been created after a day or so, please get in touch with the ``conda-forge/core`` team for help.
123123
* CI services will be enabled automatically and a build will be triggered automatically which will build the conda package and upload to `https://anaconda.org/conda-forge <https://anaconda.org/conda-forge>`_
124-
* If this is your first contribution, you will be added to the ``conda-forge`` `team <https://github.com/orgs/conda-forge/people>`_ and given access to the CI services so that you can stop and restart builds. You will also be given commit rights to the new git repository.
124+
* If this is your first contribution, you will be added to the conda-forge `team <https://github.com/orgs/conda-forge/people>`_ and given access to the CI services so that you can stop and restart builds. You will also be given commit rights to the new git repository.
125125
* If you want to make a change to the recipe, send a :term:`PR` to the git repository from a fork. Branches of the main repository are used for maintaining different versions only.
126126

127127

@@ -237,7 +237,7 @@ It defines everything that is required to build and use the package.
237237

238238
A full reference of the structure and fields of ``meta.yaml`` file can be found in the `Defining metadata (meta.yaml) <https://conda.io/projects/conda-build/en/stable/resources/define-metadata.html>`__ section in the conda-build documentation.
239239

240-
In the following, we highlight particularly important and ``conda-forge`` specific information and guidelines, ordered by section in ``meta.yaml``.
240+
In the following, we highlight particularly important and conda-forge specific information and guidelines, ordered by section in ``meta.yaml``.
241241

242242

243243
Source
@@ -270,7 +270,7 @@ install the necessary tools below).
270270

271271
To generate the ``sha256`` hash: ``openssl sha256 your_sdist.tar.gz``
272272

273-
You may need the openssl package, available on ``conda-forge``
273+
You may need the openssl package, available on conda-forge
274274
``conda install openssl -c conda-forge``.
275275

276276
.. tip::
@@ -403,13 +403,13 @@ For a detailed explanation please refer to the `conda-build documentation <https
403403
Avoid external dependencies
404404
...........................
405405

406-
As a general rule: all dependencies have to be packaged by ``conda-forge`` as well. This is necessary to assure :term:`ABI` compatibility for all our packages.
406+
As a general rule: all dependencies have to be packaged by conda-forge as well. This is necessary to assure :term:`ABI` compatibility for all our packages.
407407

408408
There are only a few exceptions to this rule:
409409

410410
#. Some dependencies have to be satisfied with :term:`CDT` packages (see :ref:`cdt_packages`).
411411

412-
#. Some packages require root access (e.g. device drivers) that cannot be distributed by ``conda-forge``. These dependencies should be avoided whenever possible.
412+
#. Some packages require root access (e.g. device drivers) that cannot be distributed by conda-forge. These dependencies should be avoided whenever possible.
413413

414414

415415

@@ -513,7 +513,7 @@ Sometimes defining tests seems to be hard, e.g. due to:
513513
- test suites may take too long to run on limited :term:`CI` infrastructure.
514514
- tests may take too much bandwidth.
515515

516-
In these cases, ``conda-forge`` may not be able to execute the prescribed test suite.
516+
In these cases, conda-forge may not be able to execute the prescribed test suite.
517517

518518
However, this is no reason for the recipe to not have tests. At the very least,
519519
we want to verify that the package has installed the desired files in the desired

src/maintainer/conda_forge_yml.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Configuring conda-forge.yml
22
***************************
33

4-
You can configure how ``conda-forge`` is set up and built via the ``conda-forge.yml``
4+
You can configure how conda-forge is set up and built via the ``conda-forge.yml``
55
file that is present in the root directory of a feedstock.
66

77
Rerendering the feedstock after you modify this file is usually required and always a good idea (see :ref:`dev_update_rerender`).
@@ -165,7 +165,7 @@ Leaving this field empty implicitly requests to build a package natively. i.e.
165165

166166
build_with_mambabuild
167167
---------------------
168-
This option, when enabled, configures the ``conda-forge`` CI to run a debug build using the ``mamba`` solver. Check `this <https://conda-forge.org/docs/maintainer/maintainer_faq.html#mfaq-mamba-local>`__ to know more.
168+
This option, when enabled, configures the conda-forge CI to run a debug build using the ``mamba`` solver. Check `this <https://conda-forge.org/docs/maintainer/maintainer_faq.html#mfaq-mamba-local>`__ to know more.
169169

170170
.. code-block:: yaml
171171
@@ -254,7 +254,7 @@ artifacts. The currently supported options are
254254
conda_forge_output_validation
255255
-----------------------------
256256

257-
This field must be set to ``True`` for feedstocks in the ``conda-forge`` GitHub
257+
This field must be set to ``True`` for feedstocks in the conda-forge GitHub
258258
organization. It enables the required feedstock artifact validation as described
259259
in :ref:`output_validation`.
260260

@@ -455,7 +455,7 @@ The relative path to the recipe directory. The default is:
455455
remote_ci_setup
456456
---------------
457457
This option can be used to override the default ``conda-forge-ci-setup`` package.
458-
Can be given with ``${url or channel_alias}::package_name``, defaults to ``conda-forge``
458+
Can be given with ``${url or channel_alias}::package_name``, defaults to conda-forge
459459
channel_alias if no prefix is given.
460460

461461
.. code-block:: yaml

src/maintainer/infrastructure.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Repositories
99
Staging area for recipes
1010
------------------------
1111

12-
`conda-forge/staged-recipes <https://github.com/conda-forge/staged-recipes>`__ is the entry point for new packages to join the ``conda-forge`` package collection.
12+
`conda-forge/staged-recipes <https://github.com/conda-forge/staged-recipes>`__ is the entry point for new packages to join the conda-forge package collection.
1313
You can find the detailed guide for submitting new package recipes in :ref:`creating_recipes`.
1414

1515
Smithy
1616
------
1717

18-
Smithy contains maintenance code for ``conda-forge``, which is used by the ``conda-smithy`` command line tool and the :ref:`dev_admservice`. Smithy lives in the repository `conda-forge/conda-smithy <https://github.com/conda-forge/conda-smithy>`_.
18+
Smithy contains maintenance code for conda-forge, which is used by the ``conda-smithy`` command line tool and the :ref:`dev_admservice`. Smithy lives in the repository `conda-forge/conda-smithy <https://github.com/conda-forge/conda-smithy>`_.
1919

2020
``conda-forge/conda-smithy`` is the right repository to report bugs for
2121

@@ -25,15 +25,15 @@ Smithy contains maintenance code for ``conda-forge``, which is used by the ``con
2525

2626
``conda-smithy`` also contains the command line tool that you should use if you rerender manually from the command line (see :ref:`dev_update_rerender`).
2727

28-
Smithy can be used beyond ``conda-forge``'s purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-``conda-forge`` infrastructures.
28+
Smithy can be used beyond conda-forge's purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-conda-forge infrastructures.
2929
(You could also consider using `Azure virtual machine scale set agents <https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/scale-set-agents?view=azure-devops>`_,
3030
which could be less expensive to run than permanently active agents.)
3131

3232

3333
Web services
3434
------------
3535

36-
The Heroku app providing the ``conda-forge`` web services lives in `conda-forge/conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`__.
36+
The Heroku app providing the conda-forge web services lives in `conda-forge/conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`__.
3737
Please note that the code logic provided by the app is in the ``Smithy`` repository.
3838

3939
Bugs or suggestions regarding the service functionality should therefore be opened in ``conda-forge/conda-smithy``'s `bug tracker <https://github.com/conda-forge/conda-smithy/issues>`__.
@@ -43,7 +43,7 @@ conda-forge pinning
4343

4444
Package-wide dependency pins are defined in `conda_build_config.yaml <https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/conda_build_config.yaml>`__ in the `conda-forge/conda-forge-pinning-feedstock <https://github.com/conda-forge/conda-forge-pinning-feedstock>`_.
4545

46-
For more information on ``conda-forge`` wide package pins, please refer to :ref:`globally_pinned_packages`.
46+
For more information on conda-forge wide package pins, please refer to :ref:`globally_pinned_packages`.
4747

4848
Please open a :term:`PR` and/or an issue there, if you think a pin needs to be advanced. For more information on updating globally pinned packages, please refer to :ref:`update_pins`.
4949

@@ -63,7 +63,7 @@ If you found any typo error, unclear explanations or new topics that can be cove
6363
Admin web services
6464
==================
6565

66-
``conda-forge`` is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
66+
conda-forge is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
6767

6868
The following services are run by default on a feedstock:
6969

@@ -117,14 +117,14 @@ all of the CI builds to restart.
117117
------------------------------------
118118

119119
Entering this command in the PR of a feedstock or staged-recipes will have the admin bot @-mention the team
120-
associated with the repo. This command can be useful for people who are not yet members of ``conda-forge`` and
120+
associated with the repo. This command can be useful for people who are not yet members of conda-forge and
121121
so cannot @-mention the ``staged-recipes`` team for PR reviews.
122122

123123
@conda-forge-admin, please ping conda-forge/<team>
124124
--------------------------------------------------
125125

126126
Entering this command in the PR of a feedstock or staged-recipes will have the admin bot @-mention the respective team.
127-
This command can be useful for people who are not yet members of ``conda-forge`` and
127+
This command can be useful for people who are not yet members of conda-forge and
128128
so cannot @-mention someone due to the general GitHub limitations.
129129

130130
@conda-forge-admin, please rerun bot
@@ -169,7 +169,7 @@ changes. The rest of the contents will be added in a subsequent commit after a f
169169
CI build services
170170
=================
171171

172-
Here we describe common issues with the CI Services that ``conda-forge`` builds.
172+
Here we describe common issues with the CI Services that conda-forge builds.
173173

174174
Azure Pipelines
175175
---------------
@@ -270,16 +270,16 @@ To skip a CI build for a given commit, put ``[ci skip] ***NO_CI***`` in the comm
270270
Third-party Use of Our CI Services
271271
----------------------------------
272272

273-
Due to its stature in the open-source community, ``conda-forge`` has enhanced access to certain CI services. This access is a community
274-
resource entrusted to ``conda-forge`` for use in building packages. We thus cannot support third-party or "off-label" CI jobs in our
273+
Due to its stature in the open-source community, conda-forge has enhanced access to certain CI services. This access is a community
274+
resource entrusted to conda-forge for use in building packages. We thus cannot support third-party or "off-label" CI jobs in our
275275
feedstocks on any of our CI services. If we find such use, we will politely ask the maintainers to rectify the situation. We may
276276
take more serious actions, including archiving feedstocks or removing maintainers from the organization, if the situation cannot be rectified.
277277

278278

279279
Compilers and Runtimes
280280
======================
281281

282-
``conda-forge`` builds and maintains its own set of compilers for various languages
282+
conda-forge builds and maintains its own set of compilers for various languages
283283
and/or systems (e.g., ``C``, ``FORTRAN``, ``C++``, ``CUDA``, etc.). These are used
284284
in all of our CI builds to build both core dependencies (e.g., ``Python``) and maintainer-contributed
285285
packages. While we do not have any formal policies or promises of support for these
@@ -343,7 +343,7 @@ works as follows.
343343
and some information about the package it is trying to upload.
344344
3. The webservices server validates the secret token, the integrity of the package, and
345345
that the package is allowed for the given feedstock.
346-
4. If all of the validation passes, the package is then copied to the ``conda-forge``
346+
4. If all of the validation passes, the package is then copied to the conda-forge
347347
channel.
348348

349349
We attempt to report errors in this process to users via comments on commits/issues in the feedstocks.

0 commit comments

Comments
 (0)