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

Commit 1a84875

Browse files
authored
docs: Clean up documentation. (#1025)
- Removed out of date known issues. - Cleaned up workflow commands. - Removed references to out of date Pycharm instructions.
1 parent 1cdbcea commit 1a84875

3 files changed

Lines changed: 6 additions & 21 deletions

File tree

README.rst

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -365,15 +365,6 @@ Some common service combinations include:
365365
.. _analyticsapi: https://github.com/openedx/edx-analytics-data-api
366366

367367

368-
Known Issues
369-
------------
370-
371-
Currently, some containers rely on Elasticsearch 7 and some rely on Elasticsearch 1.5. This is
372-
because services are in the process of being upgraded to Elasticsearch 7, but not all of them
373-
support Elasticsearch 7 yet. As we complete these migrations, we will update the dependencies
374-
of these containers.
375-
376-
377368

378369
Advanced Configuration Options
379370
------------------------------
@@ -411,7 +402,6 @@ As a specific example, if ``OPENEDX_RELEASE`` is set in your environment as ``ju
411402
.. _edx-e2e-tests README: https://github.com/edx/edx-e2e-tests/#how-to-run-lms-and-studio-tests
412403
.. _edxops Docker image: https://hub.docker.com/r/edxops/
413404
.. _Docker Hub: https://hub.docker.com/
414-
.. _Pycharm Integration documentation: docs/pycharm_integration.rst
415405
.. _devpi documentation: docs/devpi.rst
416406
.. _edx-platform testing documentation: https://github.com/openedx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
417407
.. |Build Status provisioning| image:: https://github.com/openedx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master

docs/devstack_faq.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -286,10 +286,6 @@ After changing settings, you can restart the LMS/Studio process without restarti
286286
make dev.restart-devserver.lms # For LMS
287287
make dev.restart-devserver.studio # For Studio/CMS
288288
289-
How do I integrate with PyCharm?
290-
--------------------------------
291-
292-
See the `Pycharm Integration documentation`_.
293289
294290
What is DevPI and how does it affect Devstack?
295291
----------------------------------------------
@@ -304,5 +300,4 @@ See the `devpi documentation`_.
304300
.. _Changing Themes for an Open edX Site: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/changing_appearance/theming/index.html
305301
.. _updating relational database dumps: docs/database-dumps.rst
306302
.. _Django Migration Don'ts: https://engineering.edx.org/django-migration-donts-f4588fd11b64
307-
.. _Pycharm Integration documentation: docs/pycharm_integration.rst
308303
.. _devpi documentation: docs/devpi.rst

docs/workflow.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ These instructions are written using the LMS as an example. Replace ``lms`` with
1414
#. Activate your devstack virtualenv. See the main Getting Started instructions if you don't already have one.
1515
#. Launch your service in a clean state:
1616

17-
#. Run ``make lms-down lms-pull lms-up`` to halt any running services and remove their containers, pull the latest disk images, and launch your service.
18-
#. Optionally, watch ``make lms-logs`` to follow the logs. This lets you see when the service finishes coming up, and prints the port it is listening on.
17+
#. Run ``make dev.remove-containers dev.pull.lms dev.up.lms`` to halt any running services and remove their containers, pull the latest disk images, and launch your service.
18+
#. Optionally, watch ``make dev.logs.lms`` to follow the logs. This lets you see when the service finishes coming up, and prints the port it is listening on.
1919

2020
- Your service is up when you see a block of messages that looks like the following::
2121

@@ -25,15 +25,15 @@ These instructions are written using the LMS as an example. Replace ``lms`` with
2525
edx.devstack.lms | Starting development server at http://0.0.0.0:18000/
2626
edx.devstack.lms | Quit the server with CONTROL-C.
2727

28-
- If the logs show warning messages about missing tables or needed migrations, run ``make lms-migrate`` and then continue
28+
- If the logs show warning messages about missing tables or needed migrations, run ``make dev.migrate.lms`` and then continue
2929

30-
- If there are complaints about import failures, Python package requirements may have changed since the last disk image. Run ``make lms-shell`` and then ``make requirements`` from inside the shell, then restart the service with ``make lms-restart-devserver``.
30+
- If there are complaints about import failures, Python package requirements may have changed since the last disk image. Run ``make lms-shell`` and then ``make requirements`` from inside the shell, then restart the service with ``make dev.restart-devserver.lms``.
3131

3232
#. Your service should now be up and accessible, and you can develop in your IDA's repo. When you make changes on disk, a file watcher will restart the service in devstack. It may take a moment for the service to come back up with your changes.
3333

34-
- For some changes, this auto-restarting is insufficient, and you'll need to make a change from inside ``make lms-shell`` (such as ``make requirements`` or a migrations or other management command) and then run ``make lms-restart-devserver`` from the outside.
34+
- For some changes, this auto-restarting is insufficient, and you'll need to make a change from inside ``make lms-shell`` (such as ``make requirements`` or a migrations or other management command) and then run ``make dev.restart-devserver.lms`` from the outside. Running ``make dev.restart-devserver.lms`` may also fix issues if the runserver command is not restarting automatically after code changes.
3535

36-
#. When you're done, you can either run ``make lms-stop`` to shut down the service but leave the container intact (with requirements installations and other file changes preserved) or ``make lms-down`` to destroy the containers as well.
36+
#. When you're done, you can run ``make dev.stop.lms`` to shut down the service but leave the container intact (with requirements installations and other file changes preserved).
3737

3838
Variations
3939
----------

0 commit comments

Comments
 (0)