Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move "getting started" info in README template to a central place #396

Closed
5 tasks done
timmc-edx opened this issue Oct 13, 2023 · 0 comments
Closed
5 tasks done

Move "getting started" info in README template to a central place #396

timmc-edx opened this issue Oct 13, 2023 · 0 comments
Assignees

Comments

@timmc-edx
Copy link
Contributor

timmc-edx commented Oct 13, 2023

Our repos often have a "how to develop on this repo" section in their README that describes the use of virtualenvs, git, and Open edX-specific workflows (such as make requirements). As a result, we have a large variety of READMEs with often outdated or incorrect information in this section.

A/C:

Notes:

@timmc-edx timmc-edx self-assigned this Nov 1, 2023
timmc-edx added a commit to openedx/open-edx-proposals that referenced this issue Nov 1, 2023
See openedx/edx-cookiecutters#396 -- we'd like to
centralize this information rather than templating it to every repo's
README.
timmc-edx added a commit that referenced this issue Nov 1, 2023
See #396 for details.

Also, promote "Deploying" header, which had previously been under "Getting
Started".
timmc-edx added a commit that referenced this issue Nov 1, 2023
See #396 for details.

Also, promote "Deploying" header, which had previously been under "Getting
Started".
timmc-edx added a commit to openedx/open-edx-proposals that referenced this issue Nov 1, 2023
…ng (#536)

See openedx/edx-cookiecutters#396 -- we'd like to
centralize this information rather than templating it to every repo's
README.
timmc-edx added a commit that referenced this issue Nov 8, 2023
#405)

See #396 for details.

Also, promote "Deploying" header, which had previously been under "Getting
Started".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant