Skip to content

Commit

Permalink
Merge pull request #187 from edx/markhoeber-doc1670
Browse files Browse the repository at this point in the history
Updated Preface with Portal Information
  • Loading branch information
mhoeber committed Mar 4, 2015
2 parents 9c89571 + e3fca89 commit 664bbf9
Show file tree
Hide file tree
Showing 7 changed files with 142 additions and 32 deletions.
19 changes: 16 additions & 3 deletions en_us/course_authors/source/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
Change Log
############

****************
March 2015
****************

.. list-table::
:widths: 10 70
:header-rows: 1

* - Date
- Change
* - 3 Mar 2015
- Updated the :ref:`Preface` to include information about the :ref:`The
edX Partner Portal` and the :ref:`The Open edX Portal`.

*****************
February 2015
*****************
Expand Down Expand Up @@ -269,7 +283,7 @@ June 2014
* - Date
- Change
* - 06/20/14
- Added a `Preface`_ with resources for course teams, developers,
- Added a :ref:`Preface` with resources for course teams, developers,
researchers, and students.
* - 06/18/14
- In the :ref:`View and download student data` section, updated the
Expand Down Expand Up @@ -599,5 +613,4 @@ December 2013
* - 12/05/2013
- Complete revision of edX Studio documentation and integration of edX101
content.

.. _Preface: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/

3 changes: 3 additions & 0 deletions en_us/data/source/internal_data_formats/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ January-March 2015
* -
- Added events for the display of :ref:`Google components<content>` to the
Tracking Logs chapter.
* - 3 Mar 2015
- Updated the :ref:`Preface` to include information about the :ref:`The
edX Partner Portal` and the :ref:`The Open edX Portal`.
* - 23 Feb 2015
- Added new common fields for HTTP header values and new events for video
caption use to the :ref:`Tracking Logs` chapter.
Expand Down
9 changes: 5 additions & 4 deletions en_us/developers/source/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ Change Log

* - Date
- Change
* - 01/13/15
* - 4 Mar 2015
- Updated the :ref:`Preface` to include information about the :ref:`The
edX Partner Portal` and the :ref:`The Open edX Portal`.
* - 13 Jan 2015
- Moved document to edx-documentation repo and created separate project in
edx-platform repo for internal docstrings.




3 changes: 3 additions & 0 deletions en_us/install_operations/source/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Change Log

* - Date
- Change
* - 03/02/15
- Updated the :ref:`Preface` to include information about the :ref:`The
edX Partner Portal` and the :ref:`The Open edX Portal`.
* - 02/24/2015
- Updated for the :ref:`Open edX Birch Release`.
* - 02/24/2015
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
137 changes: 112 additions & 25 deletions en_us/shared/preface.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,95 @@
.. _Preface:

.. Doc team! Be sure that when you make any changes to this file that you also make them to the mirrored file in the edx-analytics-dashboard/docs repository. - Alison 19 Aug 14
############
Preface
############

.. Doc team! Be sure that when you make any changes to this file that you also make them to the mirrored file in the edx-analytics-dashboard/docs repository. - Alison 19 Aug 14
Course teams, researchers, developers, students: the edX community includes
groups with a range of reasons for using the platform and objectives to
accomplish. To help members of each group learn about what edX offers, reach
goals, and solve problems, edX provides a variety of information resources.

To help you find what you need, browse the edX offerings in these categories:

* :ref:`Resources for Course Teams`
* :ref:`Resources for Researchers`
* :ref:`Resources for Developers`
* :ref:`Resources for Students`
* `The edX Partner Portal`_
* `The Open edX Portal`_
* `Release Announcements through the Open edX Portal`_
* `Resources for Course Teams`_
* `Resources for Researchers`_
* `Resources for Developers`_
* `Resources for Students`_

All members of the edX community are encouraged to make use of any of the
resources described in this preface.

.. _The edX Partner Portal:

***********************
The edX Partner Portal
***********************

The `edX Partner Portal`_ is the destination for partners to learn, connect,
and collaborate with one another. Partners can explore rich resources and share
success stories and best practices while staying up-to-date with important news
and updates.

To use the edX Partner Portal, you must register and request verification as an
edX partner. If you are an edX partner and have not used the edX Partner
Portal, follow these steps.

#. Visit `partners.edx.org`_, and select **Create New Account**.
#. Select **Request Partner Access**, then fill in your personal details.
#. Select **Create New Account**. You will receive a confirmation email with
your account access within 24 hours.

.. _The Open edX Portal:

***********************
The Open edX Portal
***********************

The `Open edX Portal`_ is the destination for all edX users to learn about the
edX roadmap, as well as hosting, extending the edX platform, and contributing
to Open edX. In addition, the Open edX Portal provides product announcements,
the Open edX blog, and other rich community resources.

All users can view content on the Open edX Portal without creating an account
and logging in.

To comment on blog posts or the edX roadmap, you must create an account and log
in. If you do not have an account, follow these steps.

#. Visit `open.edx.org/user/register`_.
#. Fill in your personal details.
#. Select **Create New Account**. You are then logged in to the `Open edX
Portal`_.

***************************************************
Release Announcements through the Open edX Portal
***************************************************

To receive and share product and release announcements by email, subscribe to
announcements on the `Open edX Portal`_.

#. Create an account on the `Open edX Portal`_ as described above.
#. Go to https://open.edx.org/announcements.
#. Under **Announcement Type** in the **Subscriptions** block, select the type
of announcements that you want to receive through email.

.. image:: ../../shared/images/Announcement_subscriptions.png
:alt: Subscription block in the Open edX Portal Announcements page.

4. Click **Save**.

You will now receive email messages when new announcements of the types you
selected are posted.

.. note::
EdX partners can complete the same steps on the **Announcements** page in the
`edX Partner Portal`_.

***********************
System Status
***********************
Expand Down Expand Up @@ -93,11 +162,8 @@ To receive and share information by email, course team members can:
* Join the `openedx-studio`_ Google group to ask questions and participate in
discussions with peers at other edX partner organizations and edX staffers.

Wikis and Web Sites
-------------------

The edX product team maintains the `Open edX Product`_ wiki, which includes the
`Open edX Public Product Roadmap`_.
Course Author Support
----------------------

The `edX Author Support`_ site hosts discussions that are monitored by edX
staffers.
Expand Down Expand Up @@ -155,10 +221,6 @@ Documentation for developers is available on the docs.edx.org web page.
contributing to Open edX, options for extending the Open edX platform, using
the edX public sandboxes, instrumenting analytics, and testing.

* `Installing, Configuring, and Running the edX Platform`_ provides procedures
for getting an edX developer stack (Devstack) and production stack
(Fullstack) operational.

* XBlock_: Open edX courseware components provides preliminary documentation
on the XBlock component architecture for building courses.

Expand Down Expand Up @@ -200,30 +262,49 @@ staffers.

* For conversations about the code in Open edX, join `edx-code`_.
* For conversations about running Open edX, join `openedx-ops`_.
* For conversations about globalization and translation, join `openedx-translation`_.
* For conversations about globalization and translation,
join `openedx-translation`_.

Additional Google groups are occasionally formed for individual projects.

.. note:: Please do not report security issues in public. If you have a concern,
.. note::
Please do not report security issues in public. If you have a concern,
please email security@edx.org.

EdX engineers often monitor the Freenode #edx-code IRC channel.

Wikis and Web Sites
Pull Requests
-------------------

The code.edx.org web site_ is an entry point for new contributors.

The edX Engineering team maintains the `Open Source Home`_ wiki, which provides
insights into the plans, projects, and questions that the edX Open Source team
is working on with the community.

The pull request dashboard_ is a visualization of the count and age of the
pull requests (PRs) assigned to teams at edX. Click the bars in this chart to
get more information about the PRs.

.. _Resources for Students:

.. _Resources for Open edX:

**************************
Resources for Open edX
**************************

Hosting providers, platform exenders, core contributors, and course staff all
use Open edX. Starting with the Birch release of Open edX, the following
release-specific documentation is available on docs.edx.org.

* `Open edX Release Notes`_ provides information on changes in Open edX
releases.

* `Installing, Configuring, and Running the edX Platform`_ provides procedures
for getting Devstack and Fullstack installed and operational.

* `Building and Running an Open edX Course`_ is a comprehensive guide with
concepts and procedures to help you build a course in Studio, and then
use the Learning Management System (LMS) to run a course.

When you are working in Studio, you can access relevant sections of this
guide by clicking **Help** on any page.

**************************
Resources for Students
**************************
Expand Down Expand Up @@ -307,4 +388,10 @@ edX Global Community meetup_ group.
.. _edx101: https://www.edx.org/course/overview-creating-edx-course-edx-edx101#.VIIJbWTF_yM
.. _edX Data Analytics API: http://edx.readthedocs.org/projects/edx-data-analytics-api/en/latest/index.html
.. _edX Enrollment API: http://edx.readthedocs.org/projects/edx-enrollment-api/en/latest/
.. _edX Platform API: http://edx.readthedocs.org/projects/edx-platform-api/en/latest/
.. _edX Platform API: http://edx.readthedocs.org/projects/edx-platform-api/en/latest/
.. _edX Partner Portal: https://partners.edx.org
.. _partners.edx.org: https://partners.edx.org
.. _Open edX Portal: https://open.edx.org
.. _open.edx.org/user/register: https://open.edx.org/user/register
.. _Open edX Release Notes: http://edx.readthedocs.org/projects/open-edx-release-notes/en/latest/
.. _Building and Running an Open edX Course: http://edx.readthedocs.org/projects/open-edx-building-and-running-a-course/en/named-release-birch/
3 changes: 3 additions & 0 deletions en_us/students/source/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Change Log

* - Date
- Change
* - 4 Mar 2015
- Updated the :ref:`Preface` to include information about the :ref:`The
edX Partner Portal` and the :ref:`The Open edX Portal`.
* - 20 Jan 15
- Added iPhone information to :ref:`SFD Mobile`.
* - 12/31/14
Expand Down

0 comments on commit 664bbf9

Please sign in to comment.