You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/05/20 07:31:01 UTC
[3/9] incubator-mynewt-site git commit: First cut at flattening the
docs hierarchy
First cut at flattening the docs hierarchy
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/72f78987
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/72f78987
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/72f78987
Branch: refs/heads/develop
Commit: 72f78987c2b3bd8934c4d8bea5f65256e8df48b6
Parents: b7c596d
Author: aditihilbert <ad...@runtime.io>
Authored: Thu May 19 15:57:46 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Thu May 19 15:57:46 2016 -0700
----------------------------------------------------------------------
custom-theme/documentation.html | 16 +------
custom-theme/nav.html | 13 +-----
custom-theme/toc.html | 2 +-
docs/os/get_started/introduction.md | 62 ---------------------------
docs/os/introduction.md | 62 +++++++++++++++++++++++++++
mkdocs.yml | 72 +++++++++++++++-----------------
6 files changed, 100 insertions(+), 127 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72f78987/custom-theme/documentation.html
----------------------------------------------------------------------
diff --git a/custom-theme/documentation.html b/custom-theme/documentation.html
index 43ff6fc..1261141 100644
--- a/custom-theme/documentation.html
+++ b/custom-theme/documentation.html
@@ -9,25 +9,11 @@
</div>
</div>
-<div class="bg-orange padded event-callout">
- <div class="container">
- <div class="row">
- <div class="column col-sm-12 col-md-offset-3 col-md-6 search-container text-center">
- <form id ="rtd-search-form" class="wy-form" action="{{ base_url }}/search.html" method="get">
- <div class="form-group">
- <input id="search-input" type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
- </div>
- </form>
- </div>
- </div>
- </div>
-</div>
<div class="container small-no-padding">
<div class="row">
{% for nav_item in nav %}
- {% if 'Manual' in nav_item.title or 'Guide' in nav_item.title or 'Appendix' in nav_item.title %}
+ {% if 'Documentation' in nav_item.title or 'Appendix' in nav_item.title %}
<div class="col-md-3 doc-section">
<div class="outline-title">{{ nav_item.title }}</div>
<p>{{ config.extra.chapters[nav_item.title] }}</p>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72f78987/custom-theme/nav.html
----------------------------------------------------------------------
diff --git a/custom-theme/nav.html b/custom-theme/nav.html
index dd590e6..1651409 100644
--- a/custom-theme/nav.html
+++ b/custom-theme/nav.html
@@ -28,17 +28,8 @@
<li>
<a href="/about/">About</a>
</li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
- {% for nav_item in nav %} {% if nav_item.title in ['Documentation', 'Mynewt OS Manual', 'Newt Tool Manual', 'Newt Manager Manual', 'Appendix'] %}
- <li {% if nav_item.active %}class="active" {% endif %}>
- <a href="{% if nav_item.url %}{{ nav_item.url }}{% else %}{{ nav_item.children[0].url }}{% endif %}">
- {% if nav_item.title == 'Documentation' %}Overview{% else %}{{ nav_item.title }}{% endif %}
- </a>
- </li>
- {% endif %} {% endfor %}
- </ul>
+ <li>
+ <a href="/os/introduction/">Documentation</a>
</li>
<li>
<a href="/download/">Download</a>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72f78987/custom-theme/toc.html
----------------------------------------------------------------------
diff --git a/custom-theme/toc.html b/custom-theme/toc.html
index f3b5c43..0df8dc1 100644
--- a/custom-theme/toc.html
+++ b/custom-theme/toc.html
@@ -12,7 +12,7 @@
</div>
<ul class="nav bs-sidenav">
{% for nav_item in nav %}
- {% if 'Manual' in nav_item.title or 'Guide' in nav_item.title or 'Appendix' in nav_item.title %}
+ {% if 'Documentation' in nav_item.title or 'Appendix' in nav_item.title %}
{% include 'nested_toc.html' %}
{% endif %}
{% endfor %}
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72f78987/docs/os/get_started/introduction.md
----------------------------------------------------------------------
diff --git a/docs/os/get_started/introduction.md b/docs/os/get_started/introduction.md
deleted file mode 100644
index 09240e5..0000000
--- a/docs/os/get_started/introduction.md
+++ /dev/null
@@ -1,62 +0,0 @@
-## Introduction
-
-### Welcome to Apache Mynewt
-
-Apache Mynewt is an operating system that makes it easy to develop
-applications for microcontroller environments where power and cost
-are driving factors. Examples of these devices are connected locks,
-lights, and wearables.
-
-Microcontroller environments have a number of characteristics that
-makes the operating system requirements for them unique:
-
-* Low memory footprint: memory on these systems range from
-8-16KB (on the low end) to 16MB (on the high end).
-
-* Reduced code size: code often runs out of flash, and total available code size ranges from 64-128KB to 16-32MB.
-
-* Low processing speed: processor speeds vary from 10-12MHz to 160-200MHz.
-
-* Low power operation: devices operate in mostly sleeping mode, in order to conserve
-battery power and maximize power usage.
-
-As more and more devices get connected, these interconnected devices perform complex tasks. To
-perform these tasks, you need low-level operational functionality built into the operating system.
-Typically, connected devices built with these microcontrollers perform a myriad of functions:
-
-* Networking Stacks: Bluetooth Low Energy and Thread
-
-* Peripherals: PWM to drive motors, ADCs to measure sensor data, and RTCs
-to keep time.
-
-* Scheduled Processing: actions must happen on a calendared or periodic basis.
-
-Apache Mynewt accomplishes all the above easily, by providing a complete
-operating system for constrained devices, including:
-
-* A fully open-source Bluetooth Low Energy stack with both Host and
-Controller implementations.
-
-* A pre-emptive, multi-tasking Real Time operating system kernel
-
-* A Hardware Abstraction Layer (HAL) that abstracts the MCU's
-peripheral functions, allowing developers to easily write cross-platform
-code.
-
-<br>
-
-### Newt ###
-In order to provide all this functionality, and operate in an
-extremely low resource environment, Mynewt provides a very fine-grained source
-package management and build system tool, called *newt*.
-
-You can install and build *newt* for [Linux](../../newt/install/newt_linux.md) or [Mac](../../newt/install/newt_mac.md).
-
-<br>
-
-### Build your first Mynewt App with Newt ###
-
-With the introductions out of the way, now is a good time to [get
-started](project_create/) with your first Mynewt application.
-
-Happy Hacking!
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72f78987/docs/os/introduction.md
----------------------------------------------------------------------
diff --git a/docs/os/introduction.md b/docs/os/introduction.md
new file mode 100644
index 0000000..09240e5
--- /dev/null
+++ b/docs/os/introduction.md
@@ -0,0 +1,62 @@
+## Introduction
+
+### Welcome to Apache Mynewt
+
+Apache Mynewt is an operating system that makes it easy to develop
+applications for microcontroller environments where power and cost
+are driving factors. Examples of these devices are connected locks,
+lights, and wearables.
+
+Microcontroller environments have a number of characteristics that
+makes the operating system requirements for them unique:
+
+* Low memory footprint: memory on these systems range from
+8-16KB (on the low end) to 16MB (on the high end).
+
+* Reduced code size: code often runs out of flash, and total available code size ranges from 64-128KB to 16-32MB.
+
+* Low processing speed: processor speeds vary from 10-12MHz to 160-200MHz.
+
+* Low power operation: devices operate in mostly sleeping mode, in order to conserve
+battery power and maximize power usage.
+
+As more and more devices get connected, these interconnected devices perform complex tasks. To
+perform these tasks, you need low-level operational functionality built into the operating system.
+Typically, connected devices built with these microcontrollers perform a myriad of functions:
+
+* Networking Stacks: Bluetooth Low Energy and Thread
+
+* Peripherals: PWM to drive motors, ADCs to measure sensor data, and RTCs
+to keep time.
+
+* Scheduled Processing: actions must happen on a calendared or periodic basis.
+
+Apache Mynewt accomplishes all the above easily, by providing a complete
+operating system for constrained devices, including:
+
+* A fully open-source Bluetooth Low Energy stack with both Host and
+Controller implementations.
+
+* A pre-emptive, multi-tasking Real Time operating system kernel
+
+* A Hardware Abstraction Layer (HAL) that abstracts the MCU's
+peripheral functions, allowing developers to easily write cross-platform
+code.
+
+<br>
+
+### Newt ###
+In order to provide all this functionality, and operate in an
+extremely low resource environment, Mynewt provides a very fine-grained source
+package management and build system tool, called *newt*.
+
+You can install and build *newt* for [Linux](../../newt/install/newt_linux.md) or [Mac](../../newt/install/newt_mac.md).
+
+<br>
+
+### Build your first Mynewt App with Newt ###
+
+With the introductions out of the way, now is a good time to [get
+started](project_create/) with your first Mynewt application.
+
+Happy Hacking!
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72f78987/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index a3c9b0a..2d8ff29 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -7,20 +7,21 @@ pages:
- Home: 'index.md'
- Quick Start: 'quick-start.md'
- About: 'about.md'
-- Documentation: 'documentation.md'
- Download: 'download.md'
- Community: 'community.md'
- Events: 'events.md'
-- Mynewt OS Manual:
- - Introduction: 'os/get_started/introduction.md'
- - Quick Start:
+- Mynewt Documentation:
+ - toc: 'os/introduction.md'
+ - Basic Setup:
- toc: 'os/get_started/get_started.md'
- - 'All-in-one Docker Container': 'os/get_started/docker.md'
- - 'Install Native Tools': 'os/get_started/native_tools.md'
+ - 'Option 1, Single Docker Container': 'os/get_started/docker.md'
+ - 'Option 2, Native installs':
+ - toc: 'os/get_started/native_tools.md'
+ - 'Install Newt on Mac': 'newt/install/newt_mac.md'
+ - 'Install Newt on Linux': 'newt/install/newt_linux.md'
+ - 'Install Cross Tools for ARM': 'os/get_started/cross_tools.md'
- 'Create Your First Project': 'os/get_started/project_create.md'
- - 'Install Cross Tools for ARM': 'os/get_started/cross_tools.md'
- - 'Concepts':
- - toc: 'os/get_started/vocabulary.md'
+ - Concepts: 'os/get_started/vocabulary.md'
- Tutorials:
- toc: 'os/tutorials/tutorials.md'
- 'Blinky on Arduino Zero': 'os/tutorials/arduino_zero.md'
@@ -58,7 +59,7 @@ pages:
- 'os_sched': 'os/core_os/context_switch/os_sched.md'
- 'os_arch_ctx_sw': 'os/core_os/context_switch/os_arch_ctx_sw.md'
- 'os_sched_ctx_sw_hook': 'os/core_os/context_switch/os_sched_ctx_sw_hook.md'
- - 'os_sched_get_current_task': 'os/core_os/context_switch/os_sched_get_current_task.md'
+ - 'os_/sched_get_current_task': 'os/core_os/context_switch/os_sched_get_current_task.md'
- 'os_sched_insert': 'os/core_os/context_switch/os_sched_insert.md'
- 'os_sched_next_task': 'os/core_os/context_switch/os_sched_next_task.md'
- 'os_sched_os_timer_exp': 'os/core_os/context_switch/os_sched_os_timer_exp.md'
@@ -332,34 +333,29 @@ pages:
- 'GAP in bletiny': 'network/ble/bletiny/bletiny_GAP.md'
- 'GATT in bletiny': 'network/ble/bletiny/bletiny_GATT.md'
- 'Advertisement Data Fields': 'network/ble/bletiny/bletiny_advdata.md'
-- Newt Tool Manual:
- - Introduction: 'newt/newt_intro.md'
- - Install:
- - 'Install Newt on Mac': 'newt/install/newt_mac.md'
- - 'Install Newt on Linux': 'newt/install/newt_linux.md'
- - Newt Theory of Ops: 'newt/newt_operation.md'
- - User Guide:
- - toc: 'newt/newt_ops.md'
- - 'newt build': 'newt/command_list/newt_build.md'
- - 'newt clean': 'newt/command_list/newt_clean.md'
- - 'newt create-image': 'newt/command_list/newt_create_image.md'
- - 'newt debug': 'newt/command_list/newt_debug.md'
- - 'newt help': 'newt/command_list/newt_help.md'
- - 'newt info': 'newt/command_list/newt_info.md'
- - 'newt install': 'newt/command_list/newt_install.md'
- - 'newt load': 'newt/command_list/newt_load.md'
- - 'newt new': 'newt/command_list/newt_new.md'
- - 'newt run': 'newt/command_list/newt_run.md'
- - 'newt size': 'newt/command_list/newt_size.md'
- - 'newt target': 'newt/command_list/newt_target.md'
- - 'newt test': 'newt/command_list/newt_test.md'
- - 'newt upgrade': 'newt/command_list/newt_upgrade.md'
- - 'newt version': 'newt/command_list/newt_version.md'
-- Newt Manager Manual:
- - 'Introduction': 'newtmgr/overview.md'
- - 'Install': 'newtmgr/installing.md'
- - Manual:
- - 'Protocol': 'newtmgr/protocol.md'
+ - Newt Tool Manual:
+ - toc: 'newt/newt_intro.md'
+ - Newt Theory of Ops: 'newt/newt_operation.md'
+ - Command Guide:
+ - toc: 'newt/newt_ops.md'
+ - 'newt build': 'newt/command_list/newt_build.md'
+ - 'newt clean': 'newt/command_list/newt_clean.md'
+ - 'newt create-image': 'newt/command_list/newt_create_image.md'
+ - 'newt debug': 'newt/command_list/newt_debug.md'
+ - 'newt help': 'newt/command_list/newt_help.md'
+ - 'newt info': 'newt/command_list/newt_info.md'
+ - 'newt install': 'newt/command_list/newt_install.md'
+ - 'newt load': 'newt/command_list/newt_load.md'
+ - 'newt new': 'newt/command_list/newt_new.md'
+ - 'newt run': 'newt/command_list/newt_run.md'
+ - 'newt size': 'newt/command_list/newt_size.md'
+ - 'newt target': 'newt/command_list/newt_target.md'
+ - 'newt test': 'newt/command_list/newt_test.md'
+ - 'newt upgrade': 'newt/command_list/newt_upgrade.md'
+ - 'newt version': 'newt/command_list/newt_version.md'
+ - Newt Manager User Guide:
+ - toc: 'newtmgr/overview.md'
+ - 'Install': 'newtmgr/installing.md'
- Appendix:
- 'Edit Docs': 'faq/how_to_edit_docs.md'
- 'FAQ': 'faq/answers.md'