Skip to content
This repository was archived by the owner on May 6, 2024. It is now read-only.

Commit c559067

Browse files
committedMar 21, 2024··
docs: Add a deprecation warning.
openedx/public-engineering#51 has all the details. Also drop a bunch of trailing whitespace that was in this file.
1 parent 3a436ff commit c559067

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed
 

‎README.rst

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
Configuration Management
22
########################
33

4-
This repository is a collection of tools and scripts that edx.org uses to deploy
4+
DEPRECATION WARNING
5+
*******************
6+
7+
This repository is Deprecated and is planned to be archived after the Redwood
8+
Cut (Late April 2024). See https://github.com/openedx/public-engineering/issues/51
9+
for more details and up-to-date information.
10+
11+
Description
12+
***********
13+
14+
This repository is a collection of tools and scripts that edx.org uses to deploy
515
openedx. The purpose of this repository is to share portions of our toolchain
6-
with the community. This repository is *not* the best way to get started running
16+
with the community. This repository is *not* the best way to get started running
717
openedx. For that, please look at `Open EdX Installation options`_, which contains
818
links to the recommended paths for new installations.
919

@@ -28,7 +38,7 @@ What is in this Repo?
2838
be used to configure individual services in the openedx platform. See
2939
`Open EdX Installation options`_ before trying to use any of the scripts in
3040
this directory.
31-
* `docker </docker>`__: This directory contains dockerfiles that can be used to
41+
* `docker </docker>`__: This directory contains dockerfiles that can be used to
3242
test that playbooks execute cleanly. See `Makefiles <Makefiles.rst>`__ for
3343
Documentation on how to run these containers.
3444
* `requirements </requirements>`__ : inputs for `pip-compile <https://github.com/jazzband/pip-tools>`__
@@ -44,13 +54,13 @@ Roadmap
4454
*******
4555

4656
This repository is in ``sustained`` status. The goal is to deprecate this codebase
47-
and move the deployment code into the repos with the application code.
57+
and move the deployment code into the repos with the application code.
4858

49-
With the adoption of containerized application platforms like `Kubernetes
50-
<https://kubernetes.io/>`__, the tools in this repository are complex
59+
With the adoption of containerized application platforms like `Kubernetes
60+
<https://kubernetes.io/>`__, the tools in this repository are complex
5161
and inappropriate for building small single purpose containers.
5262

53-
At edx.org, we are focusing on deployment of applications using `Terraform
63+
At edx.org, we are focusing on deployment of applications using `Terraform
5464
<https://www.terraform.io/>`__ and `Kubernetes <https://kubernetes.io/>`__. We
5565
hope to provide open source tooling for this soon.
5666

@@ -59,7 +69,7 @@ Contributing
5969
************
6070

6171
* Bugfixes: If you would like to contribute a bugfix to this codebase, please open
62-
a pull request. A bot will automatically walk your contribution through the
72+
a pull request. A bot will automatically walk your contribution through the
6373
`Open Source Contribution process <https://edx-developer-guide.readthedocs.io/en/latest/process/overview.html>`__.
6474

6575

0 commit comments

Comments
 (0)
This repository has been archived.