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 2015/11/19 00:16:12 UTC
[17/17] incubator-mynewt-site git commit: update website with stubs
for doc contributors
update website with stubs for doc contributors
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/4883e672
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/4883e672
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/4883e672
Branch: refs/heads/asf-site
Commit: 4883e6721c2d7a514941c2f538e458eb538ce074
Parents: 0682ef0
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Nov 18 15:15:37 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Nov 18 15:15:37 2015 -0800
----------------------------------------------------------------------
404.html | 261 -----
chapter1/how_to_edit_docs/index.html | 476 +++++++++
chapter1/newt_concepts/index.html | 591 +++++++-----
chapter1/project1/index.html | 900 +++++++++--------
chapter1/try_markdown/index.html | 419 ++++++++
chapter2/mod/index.html | 401 ++++++++
chapter2/project2/index.html | 587 ++++++-----
chapter2/project3/index.html | 597 +++++++-----
chapter2/vocabulary/index.html | 607 +++++++-----
chapter3/newt_ops/index.html | 603 +++++++-----
chapter3/newt_tool_reference/index.html | 603 +++++++-----
chapter4/context_switch/index.html | 536 +++++++++++
chapter4/event_queue/index.html | 536 +++++++++++
chapter4/heap/index.html | 536 +++++++++++
chapter4/mbufs/index.html | 537 +++++++++++
chapter4/memory_pool/index.html | 538 +++++++++++
chapter4/mutex/index.html | 537 +++++++++++
chapter4/mynewt_os/index.html | 557 +++++++++++
chapter4/newt_os/index.html | 261 -----
chapter4/port_os/index.html | 400 ++++++++
chapter4/sanity/index.html | 537 +++++++++++
chapter4/semaphore/index.html | 537 +++++++++++
chapter4/task/index.html | 537 +++++++++++
chapter4/time/index.html | 537 +++++++++++
chapter5/bootloader/index.html | 537 +++++++++++
chapter5/console/index.html | 1112 ++++++++++++++++-----
chapter5/filesystem/index.html | 537 +++++++++++
chapter5/mods/index.html | 261 -----
chapter5/shell/index.html | 536 +++++++++++
chapter5/testutil/index.html | 537 +++++++++++
chapter6/dist/index.html | 589 +++++++-----
css/base.css | 275 ------
css/bootstrap-custom.min.css | 1 -
css/font-awesome-4.0.3.css | 1338 --------------------------
css/theme.css | 12 +
css/theme_extra.css | 126 +++
extra.css | 9 -
fonts/fontawesome-webfont.eot | Bin 38205 -> 37405 bytes
fonts/fontawesome-webfont.svg | 31 +-
fonts/fontawesome-webfont.ttf | Bin 80652 -> 79076 bytes
fonts/fontawesome-webfont.woff | Bin 44432 -> 43572 bytes
img/grid.png | Bin 1458 -> 0 bytes
index.html | 352 -------
js/base.js | 42 -
js/bootstrap-3.0.3.min.js | 7 -
js/jquery-1.10.2.min.js | 6 -
js/jquery-2.1.1.min.js | 4 +
js/modernizr-2.8.3.min.js | 1 +
js/theme.js | 55 ++
mkdocs/search_index.json | 543 ++++++++++-
search.html | 376 ++++++++
sitemap.xml | 102 --
52 files changed, 14782 insertions(+), 5238 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/404.html
----------------------------------------------------------------------
diff --git a/404.html b/404.html
deleted file mode 100644
index d0159fd..0000000
--- a/404.html
+++ /dev/null
@@ -1,261 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
-
- <link rel="shortcut icon" href="./img/favicon.ico">
-
- <title>Mynewt</title>
-
- <link href="./css/bootstrap-custom.min.css" rel="stylesheet">
- <link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
- <link href="./css/base.css" rel="stylesheet">
- <link rel="stylesheet" href="./css/highlight.css">
- <link href="./extra.css" rel="stylesheet">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- </head>
-
- <body>
-
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="container">
-
- <!-- Collapsed navigation -->
- <div class="navbar-header">
-
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
-
- <!-- Main title -->
- <a class="navbar-brand" href=".">Mynewt</a>
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
-
- <!-- Main navigation -->
- <ul class="nav navbar-nav">
-
-
- <li >
- <a href=".">Home</a>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Started <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter1/newt_concepts/">Newt Concepts</a>
-</li>
-
-
-
-<li >
- <a href="chapter1/project1/">Blinky, The First Project</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Acclimated <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter2/vocabulary/">Understanding Newt Terms</a>
-</li>
-
-
-
-<li >
- <a href="chapter2/project2/">Project 2</a>
-</li>
-
-
-
-<li >
- <a href="chapter2/project3/">Project 3</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt Tool <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter3/newt_ops/">Command structure</a>
-</li>
-
-
-
-<li >
- <a href="chapter3/newt_tool_reference/">Command list</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt OS <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter4/newt_os/">Features</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Modules <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter5/mods/">Overview</a>
-</li>
-
-
-
-<li >
- <a href="chapter5/console/">Console</a>
-</li>
-
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Packaging it up <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="chapter6/dist/">Creating Packages</a>
-</li>
-
-
- </ul>
- </li>
-
-
- </ul>
-
-
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
- <i class="fa fa-search"></i> Search
- </a>
- </li>
-
- <li class="disabled">
- <a rel="next" >
- <i class="fa fa-arrow-left"></i> Previous
- </a>
- </li>
- <li class="disabled">
- <a rel="prev" >
- Next <i class="fa fa-arrow-right"></i>
- </a>
- </li>
-
-
- </ul>
- </div>
- </div>
-</div>
-
- <div class="container">
-
-
- <div class="row-fluid">
- <div id="main-content" class="span12">
- <h1 id="404-page-not-found" style="text-align: center">404</h1>
- <p style="text-align: center"><strong>Page not found</strong></p>
- </div>
- </div>
-
-
- </div>
-
- <footer class="col-md-12">
- <hr>
-
- <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
- </footer>
-
- <script src="./js/jquery-1.10.2.min.js"></script>
- <script src="./js/bootstrap-3.0.3.min.js"></script>
- <script src="./js/highlight.pack.js"></script>
- <script>var base_url = '.';</script>
- <script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script>
- <script src="./js/base.js"></script>
-
- <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
- <h4 class="modal-title" id="exampleModalLabel">Search</h4>
- </div>
- <div class="modal-body">
- <p>
- From here you can search these documents. Enter
- your search terms below.
- </p>
- <form role="form">
- <div class="form-group">
- <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
- </div>
- </form>
- <div id="mkdocs-search-results"></div>
- </div>
- <div class="modal-footer">
- </div>
- </div>
- </div>
- </div>
-
- </body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter1/how_to_edit_docs/index.html
----------------------------------------------------------------------
diff --git a/chapter1/how_to_edit_docs/index.html b/chapter1/how_to_edit_docs/index.html
new file mode 100644
index 0000000..0bde2b3
--- /dev/null
+++ b/chapter1/how_to_edit_docs/index.html
@@ -0,0 +1,476 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>How to edit docs - Mynewt</title>
+
+
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
+
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "How to edit docs";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
+
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../newt_concepts/">Newt Concepts</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project1/">Blinky, The First Project</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 current">
+ <a class="current" href="./">How to edit docs</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#how-to-edit-docs">How to Edit Docs</a></li>
+
+ <li><a class="toctree-l4" href="#objective">Objective</a></li>
+
+ <li><a class="toctree-l4" href="#markdown-mkdocs-mou">Markdown, MkDocs, Mou</a></li>
+
+ <li><a class="toctree-l4" href="#making-a-local-copy">Making a local copy</a></li>
+
+ <li><a class="toctree-l4" href="#file-to-be-edited">File to be edited</a></li>
+
+ <li><a class="toctree-l4" href="#editing-an-existing-page">Editing an existing page</a></li>
+
+ <li><a class="toctree-l4" href="#adding-a-new-page">Adding a new page</a></li>
+
+ <li><a class="toctree-l4" href="#pushing-changes-to-remote">Pushing changes to remote</a></li>
+
+
+ </ul>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../try_markdown/">Sample doc to edit</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_ops/">Command structure</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_tool_reference/">Command list</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mynewt_os/">Overview</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Get Started »</li>
+
+
+
+ <li>How to edit docs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="how-to-edit-docs">How to Edit Docs<a class="headerlink" href="#how-to-edit-docs" title="Permanent link">¶</a></h2>
+<h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3>
+<p>We will go through the process of downloading existing doccumentation and adding some content to a test document.</p>
+<h3 id="markdown-mkdocs-mou">Markdown, MkDocs, Mou<a class="headerlink" href="#markdown-mkdocs-mou" title="Permanent link">¶</a></h3>
+<p>The Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at <a href="http://www.mkdocs.org">http://www.mkdocs.org</a>. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs).</p>
+<p>You do not need to install MkDocs unless you want to actually render your documentation in HTML before pushing your content to the remote repository. Typically, using a Markdown editor such as <a href="http://25.io/mou/">Mou</a> is enough to check how it will look after the document has gone through MkDocs. Go ahead and download <a href="http://25.io/mou/">Mou</a>. If you are on a Windows machine, download the <a href="http://alternativeto.net/software/mou/?platform=windows">editor of your choice</a>.</p>
+<p>Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted by the group.</p>
+<h3 id="making-a-local-copy">Making a local copy<a class="headerlink" href="#making-a-local-copy" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. </p>
+<pre><code>$ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+Cloning into 'incubator-mynewt-site'...
+remote: Counting objects: 330, done.
+remote: Compressing objects: 100% (263/263), done.
+remote: Total 330 (delta 120), reused 0 (delta 0)
+Receiving objects: 100% (330/330), 4.34 MiB | 830.00 KiB/s, done.
+Resolving deltas: 100% (120/120), done.
+Checking connectivity... done.
+$ ls
+incubator-mynewt-site
+$ ls incubator-mynewt-site/
+docs images mkdocs.yml
+</code></pre>
+</li>
+<li>
+<p>Create a new branch to work on your documentation and move to that branch.</p>
+<pre><code>$ git checkout -b <your-branch-name>
+</code></pre>
+</li>
+</ul>
+<h3 id="file-to-be-edited">File to be edited<a class="headerlink" href="#file-to-be-edited" title="Permanent link">¶</a></h3>
+<p>The file you will edit is <a href="../try_markdown/">try_markdown.md</a>.</p>
+<h3 id="editing-an-existing-page">Editing an existing page<a class="headerlink" href="#editing-an-existing-page" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p>Open the application Mou.</p>
+</li>
+<li>
+<p>Open the file incubator-mynewt-site/docs/chapter1/try_markdown.md in Mou.</p>
+</li>
+<li>
+<p>Edit the last item on the list.</p>
+</li>
+<li>
+<p>Save and quit the application.</p>
+</li>
+</ul>
+<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3>
+<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named <code>ethernet.md</code> in the chapter5 subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p>
+<pre><code> - 'Ethernet': 'chapter5/ethernet.md'
+</code></pre>
+<h3 id="pushing-changes-to-remote">Pushing changes to remote<a class="headerlink" href="#pushing-changes-to-remote" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p>Set up your remote git repository</p>
+<pre><code>$ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+$ git remote -v
+origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)
+origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)
+</code></pre>
+</li>
+<li>
+<p>Commit and push the changes to the remote repository.</p>
+<pre><code>$ git add -A
+$ git commit -m "Green Arrow's first doc change"
+$ git push -u origin <your-branch-name>
+</code></pre>
+</li>
+</ul>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../try_markdown/" class="btn btn-neutral float-right" title="Sample doc to edit"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../project1/" class="btn btn-neutral" title="Blinky, The First Project"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../project1/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../try_markdown/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4883e672/chapter1/newt_concepts/index.html
----------------------------------------------------------------------
diff --git a/chapter1/newt_concepts/index.html b/chapter1/newt_concepts/index.html
index 3f1b02d..15c3a81 100644
--- a/chapter1/newt_concepts/index.html
+++ b/chapter1/newt_concepts/index.html
@@ -1,232 +1,358 @@
<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
- <link rel="canonical" href="http://mynewt.incubator.apache.org/index.html/chapter1/newt_concepts/">
- <link rel="shortcut icon" href="../../img/favicon.ico">
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Newt Concepts - Mynewt</title>
+
- <title>Newt Concepts - Mynewt</title>
+ <link rel="shortcut icon" href="../../img/favicon.ico">
- <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
- <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link href="../../css/base.css" rel="stylesheet">
- <link rel="stylesheet" href="../../css/highlight.css">
- <link href="../../extra.css" rel="stylesheet">
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../extra.css" rel="stylesheet">
-
- </head>
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Newt Concepts";
+ </script>
+
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
+ <script src="../../js/theme.js"></script>
- <body>
+
+</head>
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="container">
+<body class="wy-body-for-nav" role="document">
- <!-- Collapsed navigation -->
- <div class="navbar-header">
-
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
+ <div class="wy-grid-for-nav">
- <!-- Main title -->
- <a class="navbar-brand" href="../..">Mynewt</a>
- </div>
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href="../.." class="icon icon-home"> Mynewt</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+ <li>
+ <li class="toctree-l1 ">
+ <a class="" href="../..">Home</a>
+
+ </li>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Started</span></li>
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
+
- <!-- Main navigation -->
- <ul class="nav navbar-nav">
+ <li class="toctree-l1 current">
+ <a class="current" href="./">Newt Concepts</a>
+
+ <ul>
+
+ <li class="toctree-l3"><a href="#newt-concepts">Newt Concepts</a></li>
+ <li><a class="toctree-l4" href="#basic-components-in-the-ecosystem">Basic components in the ecosystem</a></li>
- <li >
- <a href="../..">Home</a>
- </li>
+ <li><a class="toctree-l4" href="#terminology">Terminology</a></li>
+ <li><a class="toctree-l4" href="#a-mynewt-contributor">A Mynewt contributor</a></li>
+ <li><a class="toctree-l4" href="#a-mynewt-user">A Mynewt user</a></li>
- <li class="dropdown active">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Started <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li class="active">
- <a href="./">Newt Concepts</a>
-</li>
+
+ </ul>
+
+ </li>
-
-
-<li >
- <a href="../project1/">Blinky, The First Project</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../project1/">Blinky, The First Project</a>
+
+ </li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Acclimated <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../how_to_edit_docs/">How to edit docs</a>
+
+ </li>
-
-
-<li >
- <a href="../../chapter2/project2/">Project 2</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../try_markdown/">Sample doc to edit</a>
+
+ </li>
-
-
-<li >
- <a href="../../chapter2/project3/">Project 3</a>
-</li>
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Get Acclimated</span></li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt Tool <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter3/newt_ops/">Command structure</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a>
+
+ </li>
-
-
-<li >
- <a href="../../chapter3/newt_tool_reference/">Command list</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/mod/">Modules Overview</a>
+
+ </li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Newt OS <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter4/newt_os/">Features</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project2/">Project 2</a>
+
+ </li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Modules <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter5/mods/">Overview</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter2/project3/">Project 3</a>
+
+ </li>
-
-
-<li >
- <a href="../../chapter5/console/">Console</a>
-</li>
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt Tool</span></li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Packaging it up <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-<li >
- <a href="../../chapter6/dist/">Creating Packages</a>
-</li>
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_ops/">Command structure</a>
+
+ </li>
-
- </ul>
- </li>
-
-
- </ul>
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter3/newt_tool_reference/">Command list</a>
+
+ </li>
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
- <i class="fa fa-search"></i> Search
- </a>
- </li>
-
- <li >
- <a rel="next" href="../..">
- <i class="fa fa-arrow-left"></i> Previous
- </a>
- </li>
- <li >
- <a rel="prev" href="../project1/">
- Next <i class="fa fa-arrow-right"></i>
- </a>
- </li>
-
-
- </ul>
- </div>
- </div>
-</div>
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Newt OS</span></li>
- <div class="container">
+
- <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
- <ul class="nav bs-sidenav">
-
- <li class="main active"><a href="#newt-concepts">Newt Concepts</a></li>
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mynewt_os/">Overview</a>
- <li><a href="#basic-components-in-the-ecosystem">Basic components in the ecosystem</a></li>
+ </li>
+
- <li><a href="#terminology">Terminology</a></li>
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/context_switch/">Scheduler/Context Switching</a>
- <li><a href="#a-mynewt-contributor">A Mynewt contributor</a></li>
+ </li>
+
- <li><a href="#a-mynewt-user">A Mynewt user</a></li>
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/time/">Time</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/task/">Tasks</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/event_queue/">Event Queues</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/semaphore/">Semaphores</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mutex/">Mutexes</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/memory_pool/">Memory Pools</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/heap/">Heap</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/mbufs/">Mbufs</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/sanity/">Sanity</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter4/port_os/">Porting to other Platforms</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Modules</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/console/">Console</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/shell/">Shell</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/bootloader/">Bootloader</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/filesystem/">File System</a>
+
+ </li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter5/testutil/">Test Utilities</a>
+
+ </li>
+
+
+ </ul>
+<li>
+
+ <li>
+ <ul class="subnav">
+ <li><span>Packaging it</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="../../chapter6/dist/">Creating Packages</a>
+
+ </li>
+
-
</ul>
-</div></div>
- <div class="col-md-9" role="main">
+<li>
+
+ </ul>
+ </div>
+
+ </nav>
-<h2 id="newt-concepts">Newt Concepts<a class="headerlink" href="#newt-concepts" title="Permanent link">¶</a></h2>
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../..">Mynewt</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../..">Docs</a> »</li>
+
+
+
+ <li>Get Started »</li>
+
+
+
+ <li>Newt Concepts</li>
+ <li class="wy-breadcrumbs-aside">
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="newt-concepts">Newt Concepts<a class="headerlink" href="#newt-concepts" title="Permanent link">¶</a></h2>
<p>This page introduces the basic terms you will need to find your way around the Mynewt ecosystem.</p>
<h3 id="basic-components-in-the-ecosystem">Basic components in the ecosystem<a class="headerlink" href="#basic-components-in-the-ecosystem" title="Permanent link">¶</a></h3>
<ul>
@@ -261,47 +387,50 @@
<li>Use a pre-built nest, or</li>
<li>Spawn a new nest using the newt tool for a target where a target is a custom combination of supported hardware components</li>
</ul>
-<p>In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.</p></div>
-
- </div>
-
- <footer class="col-md-12">
- <hr>
-
- <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
- </footer>
-
- <script src="../../js/jquery-1.10.2.min.js"></script>
- <script src="../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../js/highlight.pack.js"></script>
- <script>var base_url = '../..';</script>
- <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
- <script src="../../js/base.js"></script>
-
- <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
- <h4 class="modal-title" id="exampleModalLabel">Search</h4>
- </div>
- <div class="modal-body">
- <p>
- From here you can search these documents. Enter
- your search terms below.
- </p>
- <form role="form">
- <div class="form-group">
- <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
- </div>
- </form>
- <div id="mkdocs-search-results"></div>
- </div>
- <div class="modal-footer">
- </div>
- </div>
+<p>In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.</p>
+
</div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../project1/" class="btn btn-neutral float-right" title="Blinky, The First Project"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../.." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
</div>
+ </div>
+
+ </section>
+
+ </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+ <span><a href="../.." style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../project1/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
- </body>
+</body>
</html>