Skip to content

Commit

Permalink
feat: Link to getting-started instructions rather than templating them (
Browse files Browse the repository at this point in the history
#405)

See #396 for details.

Also, promote "Deploying" header, which had previously been under "Getting
Started".
  • Loading branch information
timmc-edx authored Nov 8, 2023
1 parent acc4697 commit 0debc8c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 54 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ Change Log
This file loosely adheres to the structure of https://keepachangelog.com/,
but in reStructuredText instead of Markdown.
2023-11-08
**********

Changed
=======

- Changed "Getting Started" section in templated README to link to new Open edX documentation page, and renamed to "Getting Started with Development" to clarify purpose.

2023-08-30
**********

Expand Down
58 changes: 4 additions & 54 deletions python-template/{{cookiecutter.placeholder_repo_name}}/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,63 +22,13 @@ organization. It should make clear where this fits in to the overall Open edX
codebase and should be oriented towards people who are new to the Open edX
project.

Getting Started
***************
Getting Started with Development
********************************

Developing
==========

One Time Setup
--------------
.. code-block::
# Clone the repository
git clone [email protected]:{{ cookiecutter.github_org }}/{{ cookiecutter.repo_name }}.git
cd {{ cookiecutter.repo_name }}
# Set up a virtualenv with the same name as the repo and activate it
# Here's how you might do that if you have virtualenvwrapper setup.
mkvirtualenv -p python3.8 {{ cookiecutter.repo_name }}
Every time you develop something in this repo
---------------------------------------------
.. code-block::
# Activate the virtualenv
# Here's how you might do that if you're using virtualenvwrapper.
workon {{ cookiecutter.repo_name }}
# Grab the latest code
git checkout main
git pull
# Install/update the dev requirements
make requirements
# Run the tests and quality checks (to verify the status before you make any changes)
make validate
# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>
# Using your favorite editor, edit the code to make your change.
vim ...
# Run your new tests
pytest ./path/to/new/tests
# Run all the tests and quality checks
make validate
# Commit all your changes
git commit ...
git push
# Open a PR and ask for review.
Please see the Open edX documentation for `guidance on Python development <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>`_ in this repo.

Deploying
=========
*********

TODO: How can a new user go about deploying this component? Is it just a few
commands? Is there a larger how-to that should be linked here?
Expand Down

0 comments on commit 0debc8c

Please sign in to comment.