Merge pull request #1642 from chicken-biryani/Formatting-Docs

Author: beckermr

src/contracting/00_intro.rst

@@ -1,9 +1,9 @@
 Contracting Information
 #######################
 
-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.
+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.
 However, there are a number of community members that you may engage with. 
-Conda-forge does not endorse anyone (individuals or companies) listed on this page.
+conda-forge does not endorse anyone (individuals or companies) listed on this page.
 
 
 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.

src/index.rst

@@ -13,7 +13,7 @@ Chances are we have already packaged it for you. You can `search <https://anacon
 
 **Cannot find a package or only outdated versions of a package?** - Everybody is welcome to contribute to our package stack!
 
-- We value all kinds of contributions — not just code. A few recommended ways to start contributing to ``conda-forge`` are:
+- We value all kinds of contributions — not just code. A few recommended ways to start contributing to conda-forge are:
 
  - `Contribute new packages <https://conda-forge.org/docs/maintainer/adding_pkgs.html>`__
  - Help update and `maintain packages <https://conda-forge.org/docs/maintainer/updating_pkgs.html#maintaining-pkgs>`__

src/maintainer/adding_pkgs.rst

@@ -195,7 +195,7 @@ the other packages being added as a requirement), the build script will be able
 locate the dependencies that are only present within staged-recipes as long as
 the builds finish in the dependencies order. Using a single pull request
 allows you to quickly get packages set up without waiting for each package in a
-dependency chain to be reviewed, built, and added to the conda-forge channel
+dependency chain to be reviewed, built, and added to the ``conda-forge`` channel
 before starting the process over with the next recipe in the chain.
 
 .. note::

src/maintainer/infrastructure.rst

@@ -25,7 +25,7 @@ Smithy contains maintenance code for conda-forge, which is used by the ``conda-s
 
 ``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`).
 
-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.
+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.
 (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>`_,
 which could be less expensive to run than permanently active agents.)
 
@@ -63,7 +63,7 @@ If you found any typo error, unclear explanations or new topics that can be cove
 Admin web services
 ==================
 
-Conda-forge is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
+conda-forge is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
 
 The following services are run by default on a feedstock:
 
@@ -279,7 +279,7 @@ take more serious actions, including archiving feedstocks or removing maintainer
 Compilers and Runtimes
 ======================
 
-Conda-forge builds and maintains its own set of compilers for various languages
+conda-forge builds and maintains its own set of compilers for various languages
 and/or systems (e.g., ``C``, ``FORTRAN``, ``C++``, ``CUDA``, etc.). These are used
 in all of our CI builds to build both core dependencies (e.g., ``Python``) and maintainer-contributed
 packages. While we do not have any formal policies or promises of support for these

src/maintainer/knowledge_base.rst

@@ -363,7 +363,7 @@ but merely to provide a starting point with some guidelines. Please look at `oth
 Rust Nightly
 ------------
 
-Many rust packages rely on nightly versions of the rust compiler. Given this fast release cadence, ``conda-forge`` does not yet pull each release.
+Many rust packages rely on nightly versions of the rust compiler. Given this fast release cadence, conda-forge does not yet pull each release.
 Instead, rust nightly versions are pulled into the ``dev`` branch of the `conda-forge/rust-feedstock <https://github.com/conda-forge/rust-feedstock/tree/dev>`_ on an as-needed basis.
 For a new version, please file an issue on that feedstock.
 
@@ -383,7 +383,7 @@ Core Dependency Tree Packages (CDTs)
 Dependencies outside of the ``conda-forge`` channel should be avoided (see :ref:`no_external_deps`).
 However, there are a few exceptions:
 
-Some dependencies are so close to the system that they are not packaged with ``conda-forge``.
+Some dependencies are so close to the system that they are not packaged with conda-forge.
 These dependencies have to be satisfied with *Core Dependency Tree* (CDT) packages.
 
 A CDT package consists of repackaged CentOS binaries from the appropriate version,
@@ -393,7 +393,7 @@ as opposed to generating feedstocks for them. (Note that historically we did use
 practice has been deprecated.) To add a new CDT, make a PR on the
 `conda-forge/cdt-builds <https://github.com/conda-forge/cdt-builds>`__ repo.
 
-In ``conda-forge`` the primary usages of CDTs is currently for packages that link against libGL.
+In conda-forge the primary usages of CDTs is currently for packages that link against libGL.
 
 libGL
 ^^^^^
@@ -547,7 +547,7 @@ There are a few broad cases:
 - the package works with any MPI provider (e.g. mpich, openmpi)
 - the package works with/without MPI
 
-Note that sometimes users want to use packages in ``conda-forge`` built against
+Note that sometimes users want to use packages in conda-forge built against
 our MPI libraries but linked to external MPI libraries at runtime. If you are interested
 in this procedure, see :ref:`Using External Message Passing Interface (MPI) Libraries`
 for details.
@@ -983,7 +983,7 @@ they like without any knowledge of the version of the BLAS implementation needed
 Matplotlib
 ----------
 
-``matplotlib`` on ``conda-forge`` comes in two parts. The core library is in ``matplotlib-base``. The
+``matplotlib`` on conda-forge comes in two parts. The core library is in ``matplotlib-base``. The
 actual ``matplotlib`` package is this core library plus ``pyqt``. Most, if not all, packages that have
 dependence at runtime on ``matplotlib`` should list this dependence as ``matplotlib-base`` unless they
 explicitly need ``pyqt``. The idea is that a user installing ``matplotlib`` explicitly would get a full
@@ -1378,7 +1378,7 @@ because these symbols are in fact available. To do so, add
 PyPy builds
 ===========
 
-See :ref:`pypy` in the user docs for more info about PyPy and ``conda-forge``.
+See :ref:`pypy` in the user docs for more info about PyPy and conda-forge.
 
 To build your python package for pypy, wait for the bot to send a
 PR and contact ``conda-forge/bot`` team if a PR is not sent after the
@@ -1484,7 +1484,7 @@ Finally, note that the ``aarch64`` and ``ppc64le`` platforms already use CentOS
 CUDA builds
 ===========
 
-Although the provisioned CI machines do not feature a GPU, Conda-Forge does provide mechanisms
+Although the provisioned CI machines do not feature a GPU, conda-forge does provide mechanisms
 to build CUDA-enabled packages. These mechanisms involve several packages:
 
 * ``cudatoolkit``: The runtime libraries for the CUDA toolkit. This is what end-users will end
@@ -1511,7 +1511,7 @@ On Linux, CMake users are required to use ``${CMAKE_ARGS}`` so CMake can find CU
   **How is CUDA provided at the system level?**
 
   * On Linux, Nvidia provides official Docker images, which we then
-    `adapt <https://github.com/conda-forge/docker-images>`__ to Conda-Forge's needs.
+    `adapt <https://github.com/conda-forge/docker-images>`__ to conda-forge's needs.
 
   * On Windows, the compilers need to be installed for every CI run. This is done through the
     `conda-forge-ci-setup <https://github.com/conda-forge/conda-forge-ci-setup-feedstock/>`__ scripts.
@@ -1849,21 +1849,21 @@ being investigated or the migration PR got closed accidentally. To migrate a PR
 Security considerations for conda-forge builds
 ==============================================
 
-All ``conda-forge`` packages are built by strangers on the internet on public cloud infrastructure from source code you likely have not inspected, so you should not use ``conda-forge`` packages if you or your team require a high level of security.
-You are also free to download recipes and rebuild them yourself, if you would like at least that much oversight. However, many people use ``conda-forge`` all the time with no issues and here are some things that ``conda-forge`` does to help with security in some ways:
+All conda-forge packages are built by strangers on the internet on public cloud infrastructure from source code you likely have not inspected, so you should not use conda-forge packages if you or your team require a high level of security.
+You are also free to download recipes and rebuild them yourself, if you would like at least that much oversight. However, many people use conda-forge all the time with no issues and here are some things that conda-forge does to help with security in some ways:
 
 1. `Sources <https://conda-forge.org/docs/maintainer/adding_pkgs.html#source>`_ (where you specify where the package's source code is coming from) can be pulled from GitHub, PyPI, or other sources and sha256 hashes are always used, so moving of tags or uploading of new sdists can not cause automatic package rebuilds.
    Also, once packages are accepted and made into feedstocks, only the maintainers of that feedstock have the right to merge PRs made to that feedstock.
 2. Each feedstock can only upload packages for that feedstock. This is enforced by using a cf-staging channel where builds are first sent.
-   A bot then assesses that the submitting feedstock has permission to build the package it has submitted, and only then will it relay the build to the conda-forge channel.
+   A bot then assesses that the submitting feedstock has permission to build the package it has submitted, and only then will it relay the build to the ``conda-forge`` channel.
    This helps mitigate against a bad actor gaining access to an inconspicuous feedstock and then trying to push a build with malicious code into essential infrastructure packages (e.g., OpenSSL or Python).
-3. We have `artifact-validation <https://github.com/conda-forge/artifact-validation>`__ for validating all the ``conda-forge`` artifacts uploaded to ``anaconda.org``. This validation scans for various security-related items, such as artifacts that overwrite key pieces of certain packages.
-4. We have a dedicated `Security and Systems Sub-Team <https://conda-forge.org/docs/orga/subteams.html?highlight=security+team#security-and-systems-sub-team>`__ who works hard towards making sure to secure and maintain appropriate access to the credentials and services/systems used by ``conda-forge``.
+3. We have `artifact-validation <https://github.com/conda-forge/artifact-validation>`__ for validating all the conda-forge artifacts uploaded to ``anaconda.org``. This validation scans for various security-related items, such as artifacts that overwrite key pieces of certain packages.
+4. We have a dedicated `Security and Systems Sub-Team <https://conda-forge.org/docs/orga/subteams.html?highlight=security+team#security-and-systems-sub-team>`__ who works hard towards making sure to secure and maintain appropriate access to the credentials and services/systems used by conda-forge.
 
 Significant Changes To Upstream Projects
 ========================================
 
-From time to time, we make changes in upstream projects so that they better integrate into the ``conda-forge`` ecosystem. We
+From time to time, we make changes in upstream projects so that they better integrate into the conda-forge ecosystem. We
 have listed some, but not all, of those changes here for specific projects along with any associated documentation.
 
 Python

src/maintainer/maintainer_faq.rst

@@ -94,9 +94,9 @@ FAQ
 
 .. _mfaq_package_submit:
 
-:ref:`(Q) <mfaq_package_submit>` **Is it necessary for me to be an upstream maintainer of the package I submit to Conda-forge?**
+:ref:`(Q) <mfaq_package_submit>` **Is it necessary for me to be an upstream maintainer of the package I submit to conda-forge?**
 
-  Everybody can submit a package to Conda-forge, irrespective of whether they maintain the upstream version or not. Additionally, it’s not required but considered good practice to inform the upstream of a new package and invite them to be maintainers as well.
+  Everybody can submit a package to conda-forge, irrespective of whether they maintain the upstream version or not. Additionally, it’s not required but considered good practice to inform the upstream of a new package and invite them to be maintainers as well.
 
 
 .. _mfaq_libGL_so_1:
@@ -167,12 +167,12 @@ FAQ
 
 .. _mfaq_changes_to_major_projects:
 
-:ref:`(Q) <mfaq_changes_to_major_projects>` **Does ``conda-forge`` ever make significant changes or apply code patches to significant upstream packages?**
+:ref:`(Q) <mfaq_changes_to_major_projects>` **Does conda-forge ever make significant changes or apply code patches to significant upstream packages?**
 
   We generally try to avoid changes, but there are many notable exceptions and we have no set policy. These changes currently fall into
   a few categories. Upstream projects that violate our community norms or pose significant security risks through their policies may
-  be changed so that they can be distributed on ``conda-forge``. In many cases though, these projects are not distributed at all. We
+  be changed so that they can be distributed on conda-forge. In many cases though, these projects are not distributed at all. We
   do employ extensive changes to project build scripts in order to properly build and install projects into conda environments.
   Finally, in some cases we add, enable, or disable features in specific projects to ensure they are broadly compatible with the
-  ``conda-forge`` package set. The set of patches/changes we apply is always located in the feedstock that built the package. We
+  conda-forge package set. The set of patches/changes we apply is always located in the feedstock that built the package. We
   also maintain a list of important packages with changes in our documentation.

src/maintainer/updating_pkgs.rst

@@ -6,10 +6,10 @@ Maintaining packages
 Important notes
 ===============
 
-Packages on ``conda-forge`` are immutable
+Packages on conda-forge are immutable
 -----------------------------------------
 
-As a matter of policy, we do not allow edits or the deletion of packages on ``conda-forge``. This
+As a matter of policy, we do not allow edits or the deletion of packages on conda-forge. This
 policy is very important as it increases the reliability and reproducibility of ``conda`` environments
 made with the ``conda-forge`` channel. Note that because of this policy, our upload scripts will refuse to
 upload packages which already exist on the ``conda-forge`` channel.
@@ -33,7 +33,7 @@ For updates, using a branch in the main repo is discouraged because,
    This means if you push a version update to a branch and then create a :term:`PR`, conda packages will be published to anaconda.org before the PR is merged.
 
 .. important::
-  For these reasons, maintainers are asked to fork the feedstock to their personal account, push to a branch in the fork and then open a PR to the ``conda-forge`` repo.
+  For these reasons, maintainers are asked to fork the feedstock to their personal account, push to a branch in the fork and then open a PR to the conda-forge repo.
 
 Pushing to regro-cf-autotick-bot branch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -90,7 +90,7 @@ Here we assume that you would like to update the feedstock ``<feedstock>``. Feed
    - You now have a clone of the feedstock in ``https://github.com/<your-github-id>/<feedstock>`` under your control.
    - Connect to the feedstock from your computer by using ``git clone https://github.com/<your-github-id>/<feedstock>``.
 
-#. Syncing your fork with conda-forges feedstock
+#. Syncing your fork with conda-forge's feedstock
 
    This step is only required if you have forked some time ago and your fork is missing commits from the feedstock at conda-forge.
 
@@ -240,7 +240,7 @@ To download prebuilt packages follow the steps below:
 Removing broken packages
 ========================
 
-Sometimes mistakes happen and a broken package ends up being uploaded to the conda-forge channel.
+Sometimes mistakes happen and a broken package ends up being uploaded to the ``conda-forge`` channel.
 
 If the only issue is in the package metadata, we can directly patch it using
 the `repo data patches feedstock <https://github.com/conda-forge/conda-forge-repodata-patches-feedstock>`__.
@@ -263,7 +263,7 @@ remove broken packages from the ``main`` channel:
 Archiving feedstocks
 ====================
 
-If a package is no longer maintained ``conda-forge`` will *archive*
+If a package is no longer maintained conda-forge will *archive*
 the repository. An archived repository can no longer accept PRs and issues, which prevents people and ``regro-cf-autotick-bot`` from updating the
 package (an example would be to re-render the feedstock to support new Python versions). Note that this **does not** remove the existing packages, those will still be available.
 

src/misc/00_intro.rst

@@ -22,7 +22,7 @@ Glossary
     **P**\ ull **R**\ equest. Pull Request is a workflow method to submit contributions to an open development project in which the developer asks for changes committed to an external repository to be considered for inclusion in a project's main repository. `Learn More <https://help.github.com/articles/about-pull-requests/>`__.
 
   CDT
-    **C**\ ore **D**\ ependency **T**\ ree. Core Dependency Tree packages take care of the dependencies which are so close to the system that they are not packaged with ``conda-forge``. A CDT package consists of repackaged CentOS binaries from the appropriate version, either 6 or 7 depending on user choice and platform. :ref:`Learn more<cdt_packages>`.
+    **C**\ ore **D**\ ependency **T**\ ree. Core Dependency Tree packages take care of the dependencies which are so close to the system that they are not packaged with conda-forge. A CDT package consists of repackaged CentOS binaries from the appropriate version, either 6 or 7 depending on user choice and platform. :ref:`Learn more<cdt_packages>`.
 
   ABI
     **A**\ pplication **B**\ inary **I**\ nterface. ABI is a document that comprehensively defines the binary system interface between applications and the operating system on which they run. `Learn More <https://en.wikipedia.org/wiki/Application_binary_interface>`__.

src/orga/cfep-index.rst

@@ -7,4 +7,3 @@ These CFEPs are similar to `Python's PEP <https://www.python.org/dev/peps/>`_ an
 
 CFEPs are stored in the `cfep GitHub repository <https://github.com/conda-forge/cfep>`_.
 A list of conda-forge enhancement proposals (CFEP) are as follows:
-

src/orga/governance.rst

@@ -11,7 +11,7 @@ appreciate all good faith contributions.
 
 Code of Conduct
 ---------------
-Conda-forge adheres to the
+conda-forge adheres to the
 `NumFOCUS Code of Conduct <https://www.numfocus.org/code-of-conduct>`_.
 
 Teams & Roles