conda · beckermr · Mar 15, 2025 · Mar 14, 2025 · Mar 14, 2025 · Mar 14, 2025
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,22 @@
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md033.md
+MD033:
+  # Allowed elements
+  allowed_elements:
+    - table
+    - tr
+    - td
+    - br
+    - ul
+    - li
+    - code
+    - a
+    - details
+    - summary
+    - img
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md
+MD013:
+  # Number of characters
+  # we have set this to be very high right now due to the linter not
+  # ignoring the limit for inline html and tables
+  line_length: 500
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -22,6 +22,13 @@ repos:
     hooks:
       - id: codespell
         args: [--write-changes]
+  # lint markdown
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.17.2
+    hooks:
+      - id: markdownlint-cli2
+        args: ['--fix']
+        exclude: ^.github/.*\.md$
   - repo: local
     hooks:
     - id: cep-header

diff --git a/README.md b/README.md
@@ -1,36 +1,36 @@
-## Conda Enhancement Proposals
+# Conda Enhancement Proposals
 
 [Conda](https://docs.conda.io/) is an Open Source project with a diverse and wide-ranging ecosystem.
 
 To better allow community members to provide feedback and proposals
 for conda's implementation, all major changes should be submitted as
 **Conda Enhancement Proposals (CEP)**.
 
-## Accepted CEPS:
-
-| CEP | Title |
-| --- | ------- |
-| [0000](cep-0000.md) | CEP template  |
-| [0001](cep-0001.md) | CEP Purpose and Guidelines  |
-| [0002](cep-0002.md) | Add plugin architecture to conda |
-| [0003](cep-0003.md) | Using the Mamba solver in conda |
-| [0004](cep-0004.md) | Implement initial conda plugin mechanism |
-| 0005 | _Does not exist_ |
-| [0006](cep-0006.md) | Add Channel Notices to conda
-| 0007 | _Does not exist_ |
-| [0008](cep-0008.md) | Conda Release Schedule |
-| [0009](cep-0009.md) | Conda Deprecation Schedule |
-| [0010](cep-0010.md) | Conda Version Support |
-| [0011](cep-0011.md) | Define the menuinst standard |
-| [0012](cep-0012.md) | Serving run_exports metadata in conda channels |
-| [0013](cep-0013.md) | A new recipe format – part 1 |
-| [0014](cep-0014.md) | A new recipe format – part 2 - the allowed keys & values |
+## Accepted CEPS
+
+| CEP                 | Title                                                                       |
+|---------------------|-----------------------------------------------------------------------------|
+| [0000](cep-0000.md) | CEP template                                                                |
+| [0001](cep-0001.md) | CEP Purpose and Guidelines                                                  |
+| [0002](cep-0002.md) | Add plugin architecture to conda                                            |
+| [0003](cep-0003.md) | Using the Mamba solver in conda                                             |
+| [0004](cep-0004.md) | Implement initial conda plugin mechanism                                    |
+| 0005                | _Does not exist_                                                            |
+| [0006](cep-0006.md) | Add Channel Notices to conda                                                |
+| 0007                | _Does not exist_                                                            |
+| [0008](cep-0008.md) | Conda Release Schedule                                                      |
+| [0009](cep-0009.md) | Conda Deprecation Schedule                                                  |
+| [0010](cep-0010.md) | Conda Version Support                                                       |
+| [0011](cep-0011.md) | Define the menuinst standard                                                |
+| [0012](cep-0012.md) | Serving run_exports metadata in conda channels                              |
+| [0013](cep-0013.md) | A new recipe format – part 1                                                |
+| [0014](cep-0014.md) | A new recipe format – part 2 - the allowed keys & values                    |
 | [0015](cep-0015.md) | Hosting repodata.json and packages separately by adding a base_url property |
-| [0016](cep-0016.md) | Sharded Repodata |
-| [0017](cep-0017.md) | Optional python site-packages path in repodata |
-| [0018](cep-0018.md) | Migration to the Zulip chat platform |
-| [0019](cep-0019.md) | Computing the hash of the contents in a directory |
-| [0020](cep-0020.md) | Support for `abi3` Python packages |
+| [0016](cep-0016.md) | Sharded Repodata                                                            |
+| [0017](cep-0017.md) | Optional python site-packages path in repodata                              |
+| [0018](cep-0018.md) | Migration to the Zulip chat platform                                        |
+| [0019](cep-0019.md) | Computing the hash of the contents in a directory                           |
+| [0020](cep-0020.md) | Support for `abi3` Python packages                                          |
 
 ## References
 
@@ -39,7 +39,7 @@ These proposals are similar to conda-forge's [CFEP](https://github.com/conda-for
 
 ## Writing a new CEP
 
-Community members are encouraged to author a CEP to suggest changes *before*
+Community members are encouraged to author a CEP to suggest changes _before_
 any code is written to allow for the community to discuss the proposed changes.
 
 The formal process by which CEPs should be authored and how they are reviewed

diff --git a/cep-0001.md b/cep-0001.md
@@ -10,14 +10,14 @@
 <tr><td> Implementation </td><td> NA </td></tr>
 </table>
 
-# Abstract
+## Abstract
 
 CEPs are the manner in which the conda project community suggests changes
 to the software project, and outlines how the suggested changes are reviewed.
 This document provides details on what a CEP is, how to author one,
 and the workflow used to review these proposals.
 
-# What is a CEP
+## What is a CEP
 
 CEP stands for "Conda Enhancement Proposal". A CEP is a document which
 outlines a suggested change to how the project works. These changes may be
@@ -33,7 +33,7 @@ CEPs are maintained as text files using Markdown for formatting in the
 [conda/ceps](https://github.com/conda/ceps) repository. Their revision
 history is a historical record of the proposed change.
 
-# Workflow
+## Workflow
 
 The CEP process begins with an idea for a change in how the conda project
 works. These changes can be technical or address the social aspects of the
@@ -61,22 +61,22 @@ template in [CEP 0](cep-0000.md) and described below.
 
 While working on the CEP prior to submission, please set its status to *draft*.
 
-## Submission
+### Submission
 
 Once complete, this draft should be submitted as a pull request to the
 [conda/ceps](https://github.com/conda/ceps) repository with the status
 changed to *proposed*. At this point, members of the conda community will
 review the submission.
 
-## Review
+### Review
 
 CEP review will begin once a pull request has been made. All members of the
 conda community are welcome and encouraged to participate in the review
 of CEPs in a civil and respectful manner. The CEP champion(s) should be
 prepared to answer questions on the proposal and make updates to the
 proposal as recommended by the community.
 
-## Resolution
+### Resolution
 
 All CEPs will be resolved as either *rejected*, *accepted* or *deferred*
 depending on the consensus of the community. Once the community has reached a
@@ -93,7 +93,7 @@ changes have been implemented. *Deferred* CEPs can be re-submitted in a new
 pull request if the circumstances that justified deferring instead of
 accepting or rejecting have changed.
 
-# CEP Content
+## CEP Content
 
 All CEPs should begin with a top level table with the following information:
 
@@ -129,7 +129,7 @@ A final **copyright** section is also required.
 
 CEP is to be pronounced `/sep/`.
 
-If you still have doubts about how to actually pronounce it, here is a reference (we accept UK and US pronunciations): https://dictionary.cambridge.org/dictionary/english/cep
+If you still have doubts about how to actually pronounce it, here is a reference (we accept UK and US pronunciations): <https://dictionary.cambridge.org/dictionary/english/cep>
 
 ## Conda capitalization standards
 

diff --git a/cep-0003.md b/cep-0003.md
@@ -138,7 +138,6 @@ CEP, yet to be drafted.
 - [conda-libmamba-solver]: The experimental libmamba solver
   integrations, packaged separately
 
-
 [CEP 2]: https://github.com/conda/ceps/pull/1
 [libsolv]: https://github.com/openSUSE/libsolv
 [pycosat]: https://pypi.org/project/pycosat/

diff --git a/cep-0004.md b/cep-0004.md
@@ -26,12 +26,12 @@ Plugins in `conda` will integrate the "hook + entry point" structure by utilizin
 - Define the hook(s) to be registered
 - Register the plugin under the `conda` entrypoint namespace
 
-
 ### Hook

 Below is an example of a very basic plugin "hook":
 
-_my_plugin.py_
+#### my_plugin.py
+
 ```python
 import conda.plugins
 
@@ -43,10 +43,10 @@ def conda_subcommands():
 
 ### Packaging via a `pyproject.toml` file
 
-
 Below is an example that configures `setuptools` using a `pyproject.toml` file (note that the `setup.py` file is optional if a `pyproject.toml` file is defined):
 
-_pyproject.toml_
+#### pyproject.toml
+
 ```toml
 [build-system]
 requires = ["setuptools", "setuptools-scm"]
@@ -63,12 +63,12 @@ dependencies = ["conda"]
 my-conda-plugin = "my_plugin"
 ```
 
-
 ### Packaging via a `setup.py` file
 
 Below is an example of an entry point namespace for the custom plugin function, decorated with the plugin hook shown in the "Hook" section above:
 
-_setup.py_
+#### setup.py
+
 ```python
 from setuptools import setup
 
@@ -80,7 +80,6 @@ setup(
 )
 ```
 
-
 ## Rationale
 
 This new `conda` plugin API ecosystem will bring about many benefits and possibilities, including but not limited to:

diff --git a/cep-0006.md b/cep-0006.md
@@ -10,7 +10,6 @@
     <tr><td> Implementation </td><td>https://github.com/conda/conda/pull/11462</td></tr>
 </table>
 
-
 ## Abstract
 
 In order to facilitate better communication between users of `conda` and channel owners, we want to
@@ -49,7 +48,7 @@ traffic to occur, so the requirement for having an active internet connection is
 
 Here's an example of how a notification message may appear while running the `conda create` command:
 
-```
+```bash
 $ conda create -n geopandas geopandas
 Collecting package metadata (repodata.json): done
 Solving environment: done
@@ -78,7 +77,7 @@ The following are a couple examples to show exactly how it would function:
 
 **Basic usage:** grabs notices for all current channels:
 
-```
+```bash
 $ conda notices
 
 Retrieving notices: done
@@ -96,7 +95,7 @@ Channel "conda-forge" has the following notices:
 
 **Show a single channel:** grabs notices for a single channel:
 
-```
+```bash
 $ conda notices -c defaults
 
 Channel "defaults" has the following notices:
@@ -161,7 +160,6 @@ Additionally, this new notification space can also provide a place for us to rel
 to a more visible spot (at the end of command output versus in the middle of the output). On top of this, other channels
 can use these notices as a way to share news with their users or requests for help in maintaining their channels.
 
-
 ## Rationale
 
 In order to keep this feature as a simple as possible and reduce the number of moving parts, we choose to serve
@@ -175,12 +173,10 @@ these messages if they do not want to see them while running commands such as "i
 we feel these messages are important for users to see, we also do not want to clutter their terminal output.
 Ultimately, this is why we are choosing to turn this on by default but are also providing a way to disable it.
 
-
 ## Backwards Compatibility
 
 We do not expect any backwards compatibility issues for this new feature.
 
-
 ## Alternatives
 
 - **Show notices at the beginning of environment activation:** This was deemed too intrusive/annoying.
@@ -200,12 +196,11 @@ We do not expect any backwards compatibility issues for this new feature.
   it makes more sense to put these in their own file. Plus, it allows more flexibility for dynamic routing options
   to this file if that becomes necessary in the future.
 
-
 ## References
 
 This implementation is similar to the way that `npm` handles version update reminders:
 
-```
+```bash
 npm install                                                                                                                   travishathaway@thath-work-laptop
 
 up to date, audited 365 packages in 3s
@@ -230,7 +225,7 @@ npm notice
 
 Pull request to the full implementation:
 
-https://github.com/conda/conda/pull/11462
+<https://github.com/conda/conda/pull/11462>
 
 Please add any implementation related suggestions for improvements to this pull request.
 

diff --git a/cep-0008.md b/cep-0008.md
@@ -22,6 +22,7 @@ We propose regularly scheduled bi-monthly (every two months) releases where the
 In a nod to our many different kinds of users, we will also propose a deprecation policy (to be defined in a later CEP) that allows for a slower adoption rate (i.e., users could update every 3-4 months instead).
 
 To accomplish better, more predictable versioning, we will adopt [CalVer](https://calver.org/):
+
 - `YY`: the major version will be the shortened year (22+)
 - `MM`: the minor version will be the shortened month (1-12)
 - `MICRO`: the micro/patch version is reset to zero every month and incremented for every additional release that occurs during that month (0+)

diff --git a/cep-0010.md b/cep-0010.md
@@ -35,7 +35,6 @@ The conda project already commits to maintain backwards compatibility per CEP 9.
 Any breaking changes will be announced ahead of time and go through our established
 [deprecation schedule][deprecation-schedule].
 
-
 ## Motivation
 
 The primary motivation for this CEP is setting clear expectations about how long
@@ -49,7 +48,7 @@ of conda.
 
 ## Rationale
 
-For many projects (more information here: https://endoflife.date), either
+For many projects (more information here: <https://endoflife.date>), either
 the latest version is supported or the projects have a sliding window of time
 for their supported versions. This window is a guarantee saying that the
 version in question will be supported for a specific amount of time. For most who
@@ -83,14 +82,12 @@ It has also passed since it recorded 10 "yes" votes and 0 "no" votes giving 10/1
 
 Helpful websites and articles:
 
-- https://endoflife.date
-- https://pip.pypa.io/en/latest/development/release-process/#supported-versions
-- https://devguide.python.org/versions/
-
+- <https://endoflife.date>
+- <https://pip.pypa.io/en/latest/development/release-process/#supported-versions>
+- <https://devguide.python.org/versions/>
 
 ## Copyright
 
 All CEPs are explicitly [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/).
 
-
 [deprecation-schedule]: https://github.com/conda-incubator/ceps/blob/main/cep-0009.md