From 3c0a08dc01584e8aade2eab537b21f025a79e361 Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Tue, 29 Aug 2017 07:07:05 +0000 Subject: [PATCH] [upstream] Rearrange the front page of upstream institute Current front page of upstream institute contain too much text and details which is little bit hard to read. Idea is to provide a very brief indexing and sections on front page and details for each section can be seen from corresponding links. Change-Id: I673d69ca99c599782ce4b717bea34b150df672fd --- .../source/website/index.rst | 204 +++++------------- .../source/website/upstream-archives.rst | 10 + .../website/upstream-trainees-guide.rst | 27 +++ .../website/upstream-trainers-guide.rst | 8 + .../website/upstream-training-content.rst | 57 +++++ .../upstream-training-other-events.rst | 45 ++++ .../website/upstream-training-summit.rst | 15 ++ 7 files changed, 210 insertions(+), 156 deletions(-) create mode 100644 doc/upstream-training/source/website/upstream-trainees-guide.rst create mode 100644 doc/upstream-training/source/website/upstream-training-content.rst create mode 100644 doc/upstream-training/source/website/upstream-training-other-events.rst create mode 100644 doc/upstream-training/source/website/upstream-training-summit.rst diff --git a/doc/upstream-training/source/website/index.rst b/doc/upstream-training/source/website/index.rst index 8ee6fac6..415a551b 100644 --- a/doc/upstream-training/source/website/index.rst +++ b/doc/upstream-training/source/website/index.rst @@ -16,8 +16,13 @@ OpenStack Upstream Institute git upstream-archives upstream-trainers-guide + upstream-training-other-events + upstream-training-content + upstream-training-summit + upstream-trainees-guide -Abstract + +Overview ======== With over 2,000 developers from over 300 different organizations worldwide, @@ -40,99 +45,62 @@ documentation for review. The attendees are also given the opportunity to join a mentoring program to get further help and guidance on their journey to become an active and successful member of the OpenStack community. -For more information, see :doc:`upstream-details`. - Please note that the language of the training is English. -When and where to get an OpenStack Upstream Institute class -=========================================================== +Trainings +========= -Summits -------- +We run the full training prior to each OpenStack Summit. -We run the full training prior to each OpenStack Summit, see this web page and -the schedule of the upcoming event for more details and registration. +We are also bringing a one day long version of the training to some of the +local OpenStack Days events and other industry events. +Keep a look out for updates about these events in the `Upcoming Trainings`_ +section. -OpenStack Summit Sydney -+++++++++++++++++++++++ +:doc:`upstream-details`: : A detailed overview of OpenStack Upstream Institute +Training. -The upcoming `OpenStack Summit -`_ will be in Sydney in -November with a full training running prior to the event. +Training Content +---------------- -`Etherpad for Sydney Upstream Collaboration Training -`_ +Complete content of Upstream Institute Training can be seen here: - **Saturday, November 04, 2017 - Sunday, November 05, 2017** +* :doc:`upstream-training-content` - More details coming soon... +Upcoming Trainings +------------------ -Other events ------------- +See this web page and the schedule of the upcoming class for more details +and registration. -We are bringing a one day long version of the training to some of the local -OpenStack Days events and other industry events. Keep your eyes open for these -events and check back on this website to find new occasions. ++----------+----------+---------+------------+--------------------------------+ +| Date | Event | Duration| Location | Details | ++==========+==========+=========+============+================================+ +| September| OpenStack| 1 Day| London, UK | :ref:`openstack-day-uk` | +| 26, 2017 | Days UK | | | \ | ++----------+----------+---------+------------+--------------------------------+ +| October | OpenStack| 1 Day| Copenhagen,| :ref:`openstack-day-nordic`| +| 18, 2017 | Days | | Denmark | \ | +| | Nordic | | | | ++----------+----------+---------+------------+--------------------------------+ +| November | OpenStack| 1.5 | Sydney, | :doc:`upstream-training-summit`| +| 04, 2017 | Summit | Days| Australia | \ | +| | Sydney | | | | ++----------+----------+---------+------------+--------------------------------+ -OpenStack Days UK -+++++++++++++++++ -You can access the training in parallel to the `OpenStack Days UK -`_ event. +For Trainees +============ +Prerequisite and best practice guide for trainees: - **Tuesday, September 26, 2017 at 11:00 a.m. to 5:30 p.m. (local time)** +* :doc:`upstream-trainees-guide` -Please see the `OpenStack Upstream Institute Office Hours -`_ -class information for more details. +For Trainers +============ +Tips and best practices guide for trainers, coaches and mentors holding the +training locally: -`Etherpad for London Upstream Collaboration Training -`_ - -See YOU in London! - -OpenStack Days Nordic -+++++++++++++++++++++ - -You can access the training on the first day of the `OpenStack Days Nordic -`_ event. - - **Wednesday, October 18, 2017 at 08:30 a.m. to 4:30 p.m. (local time)** - -Please see the `Becoming a member of the OpenStack community Part 1 -`_ and -`Becoming a member of the OpenStack community Part 2 -`_ pages for class -information and more details. - -`Etherpad for Nordic Upstream Collaboration Training -`_ - -See YOU in Copenhagen! - -.. _prepare-environment: - -How to prepare -============== - -* Make sure you have a wifi enabled laptop with you. -* Prepared virtual machine image with a development environment: - - * Image and instructions: https://github.com/openstack/upstream-institute-virtual-environment - -* Prepare an environment by yourself from scratch: - - * Create a virtual machine on your laptop with Ubuntu 16.04 installed and - 6+ GB of RAM. - * Alternatively, you can use your virtual machine on a public cloud. - * Check that you can ssh from your laptop to the virtual machine - * Check that :command:`apt install` works on the virtual machine - * Read and complete the :doc:`irc` guide. - * Read and complete the :doc:`git` guide. - -* Read and complete the :doc:`accounts` guide. (**Note:** you will need to sign - the Individual Contributor License Agreement - (`ICLA `_) during this.) +* :doc:`upstream-trainers-guide` Staff ===== @@ -140,7 +108,8 @@ Staff Training organizers ------------------- -Ildiko Vancsa, Kendall Nelson +Ildiko Vancsa: ildiko@openstack.org +Kendall Nelson: knelson@openstack.org Further trainers/coaches ------------------------ @@ -149,87 +118,10 @@ You can find the list of trainers/coaches on the `training occaisons `_ wiki page. -Best Practices for Trainers -=========================== - -If you're joining the training activities as a trainer, coach, or if you hold -training sessions locally you can find some tips and best practices to consider -before hosting the class provided on the :doc:`upstream-trainers-guide` page. - -We have collected the suggestions based on our experiences from previous -Upstream Institute trainings. - -Outline and online slide index -============================== - -.. tip:: Slides are made with `Hieroglyph `_. - To skim through slides quickly to find something, or jump ahead or back, - use *Slide table* (press :command:`t` in the browser). Some slides - include additional explanation in the *Presenter notes* (press - :command:`c` to see them). - -Introduction ------------- - -* `Introduction `_ -* `Introducing OpenStack as a Software `_ -* `Introducing OpenStack as a Community `_ - -Setup the Development Environment ---------------------------------- - -* `Environment Setup `_ - -How OpenStack is Made ---------------------- - -* `Official OpenStack projects `_ -* `OpenStack Governance `_ -* `Release cycle `_ -* `Communication `_ -* `OpenStack Events `_ - -Workflow and Tools for Participation ------------------------------------- - -* `Overview of the contribution process - `_ -* `Registration and accounts `_ -* `Task Tracking `_ -* `Gerrit `_ -* `Reviewing `_ -* `Commit Messages `_ -* `Project Status and Zuul `_ -* `Metrics `_ -* `Guide to SetUp and Push First Patch - `_ -* `Using Sandbox for Practice `_ - -Code Deep Dive --------------- - -* `Demo environment `_ -* `Code exercises `_ - -Other ------------------------ - -* `Documentation Deep Dive `_ - Archives ======== For more information about the past trainings and the local upstream trainings, see :doc:`upstream-archives`. -Archive of additional training activities ------------------------------------------ - -.. note:: Activities listed here are not realized at every Upstream training. - -* `Lego applied to Free Software contributions - `_ -* `Closing Exercise `_ -* `Branching model `_ - `Complete index in slide format only `_ diff --git a/doc/upstream-training/source/website/upstream-archives.rst b/doc/upstream-training/source/website/upstream-archives.rst index 0ad9d5a0..cbc05a90 100644 --- a/doc/upstream-training/source/website/upstream-archives.rst +++ b/doc/upstream-training/source/website/upstream-archives.rst @@ -328,3 +328,13 @@ Japan OpenStack User Group has held the Upstream Training in Japan. * - October 10 - 11, 2014 (Fri - Sat) - More information: http://www.openstack.org/blog/2014/11/openstack-upstream-training-in-japan/ + +Archive of additional training activities +----------------------------------------- + +.. note:: Activities listed here are not realized at every Upstream training. + +* `Lego applied to Free Software contributions + `_ +* `Closing Exercise `_ +* `Branching model `_ diff --git a/doc/upstream-training/source/website/upstream-trainees-guide.rst b/doc/upstream-training/source/website/upstream-trainees-guide.rst new file mode 100644 index 00000000..89efb521 --- /dev/null +++ b/doc/upstream-training/source/website/upstream-trainees-guide.rst @@ -0,0 +1,27 @@ +============================================ +OpenStack Upstream Institute Trainees' Guide +============================================ + +.. _prepare-environment: + +How to prepare +============== + +* Make sure you have a wifi enabled laptop with you. +* Prepared virtual machine image with a development environment: + + * Image and instructions: https://github.com/openstack/upstream-institute-virtual-environment + +* Prepare an environment by yourself from scratch: + + * Create a virtual machine on your laptop with Ubuntu 16.04 installed and + 6+ GB of RAM. + * Alternatively, you can use your virtual machine on a public cloud. + * Check that you can ssh from your laptop to the virtual machine + * Check that :command:`apt install` works on the virtual machine + * Read and complete the :doc:`irc` guide. + * Read and complete the :doc:`git` guide. + +* Read and complete the :doc:`accounts` guide. (**Note:** you will need to sign + the Individual Contributor License Agreement + (`ICLA `_) during this.) diff --git a/doc/upstream-training/source/website/upstream-trainers-guide.rst b/doc/upstream-training/source/website/upstream-trainers-guide.rst index 878e33ee..be0b733a 100644 --- a/doc/upstream-training/source/website/upstream-trainers-guide.rst +++ b/doc/upstream-training/source/website/upstream-trainers-guide.rst @@ -2,6 +2,14 @@ OpenStack Upstream Institute Trainers' Guide ============================================ +If you're joining the training activities as a trainer, coach, or if you hold +training sessions locally you can refer to this document to find some tips and +best practices to consider before hosting the class. + +We have collected the suggestions based on our experiences from previous +Upstream Institute trainings. + + General tips for Trainers and Coaches ===================================== diff --git a/doc/upstream-training/source/website/upstream-training-content.rst b/doc/upstream-training/source/website/upstream-training-content.rst new file mode 100644 index 00000000..e0f16a37 --- /dev/null +++ b/doc/upstream-training/source/website/upstream-training-content.rst @@ -0,0 +1,57 @@ +============================================= +OpenStack Upstream Institute Training Content +============================================= + +.. tip:: Slides are made with `Hieroglyph `_. + To skim through slides quickly to find something, or jump ahead or back, + use *Slide table* (press :command:`t` in the browser). Some slides + include additional explanation in the *Presenter notes* (press + :command:`c` to see them). + +Introduction +------------ + +* `Introduction `_ +* `Introducing OpenStack as a Software `_ +* `Introducing OpenStack as a Community `_ + +Setup the Development Environment +--------------------------------- + +* `Environment Setup `_ + +How OpenStack is Made +--------------------- + +* `Official OpenStack projects `_ +* `OpenStack Governance `_ +* `Release cycle `_ +* `Communication `_ +* `OpenStack Events `_ + +Workflow and Tools for Participation +------------------------------------ + +* `Overview of the contribution process + `_ +* `Registration and accounts `_ +* `Task Tracking `_ +* `Gerrit `_ +* `Reviewing `_ +* `Commit Messages `_ +* `Project Status and Zuul `_ +* `Metrics `_ +* `Guide to SetUp and Push First Patch + `_ +* `Using Sandbox for Practice `_ + +Code Deep Dive +-------------- + +* `Demo environment `_ +* `Code exercises `_ + +Other +----------------------- + +* `Documentation Deep Dive `_ diff --git a/doc/upstream-training/source/website/upstream-training-other-events.rst b/doc/upstream-training/source/website/upstream-training-other-events.rst new file mode 100644 index 00000000..d70cef9b --- /dev/null +++ b/doc/upstream-training/source/website/upstream-training-other-events.rst @@ -0,0 +1,45 @@ +======================================== +Upstream Institute Training Other Events +======================================== + + +.. _openstack-day-uk: + +OpenStack Days UK +----------------- + +You can access the training in parallel to the `OpenStack Days UK +`_ event. + + **Tuesday, September 26, 2017 at 11:00 a.m. to 5:30 p.m. (local time)** + +Please see the `OpenStack Upstream Institute Office Hours +`_ +class information for more details. + +`Etherpad for London Upstream Collaboration Training +`_ + +See YOU in London! + + +.. _openstack-day-nordic: + +OpenStack Days Nordic +--------------------- + +You can access the training on the first day of the `OpenStack Days Nordic +`_ event. + + **Wednesday, October 18, 2017 at 08:30 a.m. to 4:30 p.m. (local time)** + +Please see the `Becoming a member of the OpenStack community Part 1 +`_ and +`Becoming a member of the OpenStack community Part 2 +`_ pages for class +information and more details. + +`Etherpad for Nordic Upstream Collaboration Training +`_ + +See YOU in Copenhagen! diff --git a/doc/upstream-training/source/website/upstream-training-summit.rst b/doc/upstream-training/source/website/upstream-training-summit.rst new file mode 100644 index 00000000..4fc5e101 --- /dev/null +++ b/doc/upstream-training/source/website/upstream-training-summit.rst @@ -0,0 +1,15 @@ +======================= +OpenStack Summit Sydney +======================= + +The upcoming `OpenStack Summit +`_ will be in Sydney in +November with a full training running prior to the event. + +`Etherpad for Sydney Upstream Collaboration Training +`_ + + **Saturday, November 04, 2017 - Sunday, November 05, 2017** + + More details coming soon... +