mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-09-27 19:59:02 +00:00
Improve docs regarding opening issues
This commit is contained in:
parent
d5890dadfb
commit
5e45e80c50
4
.github/ISSUE_TEMPLATE.md
vendored
4
.github/ISSUE_TEMPLATE.md
vendored
@ -4,8 +4,8 @@ Include the exact command that you are running and that is causing an error. In
|
|||||||
|
|
||||||
## Unexpected behavior
|
## Unexpected behavior
|
||||||
|
|
||||||
Include the full, exact output from the command that is causing your issue.
|
Include the full, exact output from the command that is causing your issue. Also include relevant error logs; for instance, to debug the LMS take a look at the files in `data/lms/logs`.
|
||||||
|
|
||||||
## Additional info
|
## Additional info
|
||||||
|
|
||||||
Include the output of the `make debug` command.
|
Include the output of the `make info` command.
|
||||||
|
2
Makefile
2
Makefile
@ -55,7 +55,7 @@ stop:
|
|||||||
|
|
||||||
##################### Extra
|
##################### Extra
|
||||||
|
|
||||||
debug:
|
info:
|
||||||
uname -a
|
uname -a
|
||||||
@echo "-------------------------"
|
@echo "-------------------------"
|
||||||
docker version
|
docker version
|
||||||
|
10
README.md
10
README.md
@ -225,10 +225,12 @@ This might occur when you try to run the latest version of `edx-platform`, and n
|
|||||||
|
|
||||||
This project is the follow-up of my work on an [install from scratch of Open edX](https://github.com/regisb/openedx-install). It does not rely on any hack or complex deployment script. In particular, we do not use the Open edX [Ansible deployment playbooks](https://github.com/edx/configuration/). That means that the folks at edX.org are *not* responsible for troubleshooting issues of this project. Please don't bother Ned ;-)
|
This project is the follow-up of my work on an [install from scratch of Open edX](https://github.com/regisb/openedx-install). It does not rely on any hack or complex deployment script. In particular, we do not use the Open edX [Ansible deployment playbooks](https://github.com/edx/configuration/). That means that the folks at edX.org are *not* responsible for troubleshooting issues of this project. Please don't bother Ned ;-)
|
||||||
|
|
||||||
If you have a problem, feel free to open a [Github issue](https://github.com/regisb/openedx-docker/issues) that describes:
|
Do you have a problem?
|
||||||
- the problem you are facing: this includes the exact error message, or a screenshot of the error.
|
|
||||||
- what action triggered the error: which command line instruction, which url you tried to access, etc.
|
1. Carefully read the README, and in particular the [troubleshooting](#troubleshooting) section
|
||||||
- any error logs that you may find: you may want to take a look at the files in `data/lms/logs`, for instance.
|
2. Search for your problem among [open and closed Github issues](https://github.com/regisb/openedx-docker/issues?utf8=%E2%9C%93&q=is%3Aissue)
|
||||||
|
3. If necessary, open an [issue on Github](https://github.com/regisb/openedx-docker/issues/new).
|
||||||
|
|
||||||
|
|
||||||
## Known missing features
|
## Known missing features
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user