From d7dd441334c198548a6907591fd227615c5dde22 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 1 Nov 2023 17:54:49 -0400 Subject: [PATCH] docs: Fix up front matter section in tutorial --- docs/xblock-tutorial/front_matter/browsers.rst | 8 +++++++- docs/xblock-tutorial/front_matter/index.rst | 1 - docs/xblock-tutorial/front_matter/preface.rst | 9 ++++++++- docs/xblock-tutorial/front_matter/read_me.rst | 11 +++++++---- 4 files changed, 22 insertions(+), 7 deletions(-) diff --git a/docs/xblock-tutorial/front_matter/browsers.rst b/docs/xblock-tutorial/front_matter/browsers.rst index 7f2a1b17d..f328b77ef 100644 --- a/docs/xblock-tutorial/front_matter/browsers.rst +++ b/docs/xblock-tutorial/front_matter/browsers.rst @@ -1 +1,7 @@ -.. include:: ../../../shared/browsers.rst \ No newline at end of file +*************** +Browser Support +*************** + +For the latest information on browser support for the Open edX platform, +see `Browser Support on docs.openedx.org `_. + diff --git a/docs/xblock-tutorial/front_matter/index.rst b/docs/xblock-tutorial/front_matter/index.rst index 4a34be27e..6a96979f2 100644 --- a/docs/xblock-tutorial/front_matter/index.rst +++ b/docs/xblock-tutorial/front_matter/index.rst @@ -10,4 +10,3 @@ General Information read_me preface browsers - diff --git a/docs/xblock-tutorial/front_matter/preface.rst b/docs/xblock-tutorial/front_matter/preface.rst index 2185b5656..7c643e3dd 100644 --- a/docs/xblock-tutorial/front_matter/preface.rst +++ b/docs/xblock-tutorial/front_matter/preface.rst @@ -1 +1,8 @@ -.. include:: ../../../shared/preface.rst \ No newline at end of file +****** +TODOOO +****** + +This file brought in ``../../../shared/preface.rst`` - do we still want +that content? If so it should be put somewhere on docs.openedx.org and +then linked to from this document. + diff --git a/docs/xblock-tutorial/front_matter/read_me.rst b/docs/xblock-tutorial/front_matter/read_me.rst index ce1329b36..c96257909 100644 --- a/docs/xblock-tutorial/front_matter/read_me.rst +++ b/docs/xblock-tutorial/front_matter/read_me.rst @@ -6,8 +6,11 @@ The *Open edX XBlock Tutorial* is created using RST_ files and Sphinx_. You, the user community, can help update and revise this documentation project on GitHub. -https://github.com/openedx/edx-documentation/tree/master/en_us/xblock-tutorial/source +https://github.com/openedx/XBlock/tree/master/docs/xblock-tutorial/ -The edX documentation team welcomes contributions from Open edX community -members. You can find guidelines for how to `contribute to edX Documentation`_ -in the GitHub edx/edx-documentation repository. +The Open edX community welcomes contributions from other Open edX community +members. You can find guidelines for how to `contribute to Open edX documentation`_ +in the GitHub openedx/docs.openedx.org repository - although note that these +specific docs are authored in the openedx/XBlock repository. + +.. _contribute to Open edX documentation: https://github.com/openedx/docs.openedx.org#readme