From ef8510e4f97cf47adbfd99d855c835ab8678d51b Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 12 Sep 2020 11:10:29 -0700 Subject: [PATCH 1/4] add help page to docs and update README --- README.md | 19 +++++++++++++++---- docs/source/index.rst | 7 ++----- docs/source/need_help.rst | 27 +++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 9 deletions(-) create mode 100644 docs/source/need_help.rst diff --git a/README.md b/README.md index 4a0828170..316a899be 100644 --- a/README.md +++ b/README.md @@ -71,15 +71,26 @@ pip install nbconvert[test] py.test --pyargs nbconvert ``` -## Resources +## Documentation - [Documentation for Jupyter nbconvert](https://nbconvert.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/nbconvert/latest/nbconvert.pdf)] - [nbconvert examples on GitHub](https://github.com/jupyter/nbconvert-examples) -- [Issues](https://github.com/jupyter/nbconvert/issues) -- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) -- [Project Jupyter website](https://jupyter.org) - [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] +## Technical Support + +- [Issues and Bug Reports](https://github.com/jupyter/nbconvert/issues): A place to report + bugs or regressions found for nbconvert +- [Community Technical Support and Discussion - Discourse](https://discourse.jupyter.org/): A place for + installation, configuration, and troubleshooting assistannce by the Jupyter community. + As a non-profit project and maintainers who are primarily volunteers, we encourage you + to ask questions and share your knowledge on Discourse. + +## Jupyter Resources + +- [Jupyter mailing list](https://groups.google.com/forum/#!forum/jupyter) +- [Project Jupyter website](https://jupyter.org) + [Jinja]: http://jinja.pocoo.org/ diff --git a/docs/source/index.rst b/docs/source/index.rst index 969528e43..2ae628adb 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -65,13 +65,10 @@ batch of notebook files to another format. changelog .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :caption: Questions? Suggestions? - Jupyter mailing list - Jupyter website - Stack Overflow - Jupyter - Stack Overflow - Jupyter-notebook + need_help Indices and tables ================== diff --git a/docs/source/need_help.rst b/docs/source/need_help.rst new file mode 100644 index 000000000..3c41129f2 --- /dev/null +++ b/docs/source/need_help.rst @@ -0,0 +1,27 @@ +Need help? +========== + +Technical Support +----------------- + +- `GitHub Issues and Bug Reports`_: A + place to report bugs or regressions found for nbconvert +- `Community Technical Support and Discussion - Jupyter Discourse `_: + A place for installation, configuration, and troubleshooting assistance by the Jupyter community. + As a non-profit project with maintainers who are primarily volunteers, we rely on the community + for technical support. Please use Discourse to ask questions and share your knowledge. + +Documentation +------------- + +- `Documentation for Jupyter nbconvert `_ +- `nbconvert examples repo on GitHub `_ +- `Documentation for Project Jupyter `_ + `PDF `_ + +Jupyter Resources +----------------- + +- `Jupyter mailing list `_ +- `Project Jupyter website `_ \ No newline at end of file From ef183cfb8fb5c3488c03e5a921833e75f8117c5e Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 12 Sep 2020 11:19:08 -0700 Subject: [PATCH 2/4] remove duplicate link --- docs/source/need_help.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/need_help.rst b/docs/source/need_help.rst index 3c41129f2..e079b3fad 100644 --- a/docs/source/need_help.rst +++ b/docs/source/need_help.rst @@ -18,7 +18,6 @@ Documentation `PDF `_ - `nbconvert examples repo on GitHub `_ - `Documentation for Project Jupyter `_ - `PDF `_ Jupyter Resources ----------------- From a25b73f2ee23a4536d307d0fd882b41b61695033 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 12 Sep 2020 11:25:34 -0700 Subject: [PATCH 3/4] add space --- docs/source/need_help.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/need_help.rst b/docs/source/need_help.rst index e079b3fad..2655c22a7 100644 --- a/docs/source/need_help.rst +++ b/docs/source/need_help.rst @@ -4,7 +4,7 @@ Need help? Technical Support ----------------- -- `GitHub Issues and Bug Reports`_: A +- `GitHub Issues and Bug Reports `_: A place to report bugs or regressions found for nbconvert - `Community Technical Support and Discussion - Jupyter Discourse `_: A place for installation, configuration, and troubleshooting assistance by the Jupyter community. From 3e58d68328155205700289b9485fd9118fc8a366 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 12 Sep 2020 11:34:43 -0700 Subject: [PATCH 4/4] yeesh rst --- docs/source/need_help.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/need_help.rst b/docs/source/need_help.rst index 2655c22a7..889644cfa 100644 --- a/docs/source/need_help.rst +++ b/docs/source/need_help.rst @@ -14,7 +14,7 @@ Technical Support Documentation ------------- -- `Documentation for Jupyter nbconvert `_ `PDF `_ - `nbconvert examples repo on GitHub `_ - `Documentation for Project Jupyter `_