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/10 09:43:15 UTC
incubator-mynewt-site git commit: updating index.html with asf
project info
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/asf-site f69912ae7 -> 0682ef091
updating index.html with asf project info
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/0682ef09
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/0682ef09
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/0682ef09
Branch: refs/heads/asf-site
Commit: 0682ef09123b5ad53668a523a74ca635b0e958b5
Parents: f69912a
Author: aditihilbert <ad...@runtime.io>
Authored: Tue Nov 10 00:42:59 2015 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Tue Nov 10 00:42:59 2015 -0800
----------------------------------------------------------------------
index.html | 76 +++++++++++++++++++++++++++++++++++++++----
mkdocs/search_index.json | 4 +--
2 files changed, 72 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0682ef09/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index a4cc300..e25fe57 100644
--- a/index.html
+++ b/index.html
@@ -213,31 +213,95 @@
<li class="main active"><a href="#objective-of-mynewt">Objective of Mynewt</a></li>
+ <li><a href="#project-git-repository">Project GIT Repository</a></li>
+
+ <li><a href="#project-information-links">Project Information Links</a></li>
+
+ <li><a href="#mailing-lists">Mailing Lists</a></li>
+
+ <li><a href="#project-documentation">Project Documentation</a></li>
+
+ <li><a href="#contributing-to-documentation">Contributing to Documentation</a></li>
+
</ul>
</div></div>
<div class="col-md-9" role="main">
+<h1 id="_1"><img alt="ASF Incubator Logo" src="./images/egg-logo.png" /><a class="headerlink" href="#_1" title="Permanent link">¶</a></h1>
<h2 id="objective-of-mynewt">Objective of Mynewt<a class="headerlink" href="#objective-of-mynewt" title="Permanent link">¶</a></h2>
-<p>Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.</p>
+<p>Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.</p>
<p>The world of Mynewt, therefore, has three primary collaborative goals:</p>
<ul>
<li>Build a modularized real-time operating system for a rich set of hardware components</li>
<li>Offer a suite of open-source software for efficient and secure two-way communications with an embedded device</li>
<li>Develop method and tools necessary to build an optimized executable image on the desired hardware</li>
</ul>
-<p>The chapter organization is outlined below. Each Chapter has one or more tutorials for hands-on experience with the material in each chapter. </p>
+<h3 id="project-git-repository">Project GIT Repository<a class="headerlink" href="#project-git-repository" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p><a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git">Documentation repository</a> containing the markdown docs that generate the html pages you see here.</p>
+</li>
+<li>
+<p><a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git">Mynewt OS development repository (larva)</a> containing all code packages for newt operating system and middleware software being worked on.</p>
+</li>
+<li>
+<p><a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git">Newt tool development repository (newt)</a> containing source code for the newt tool.</p>
+</li>
+</ul>
+<h3 id="project-information-links">Project Information Links<a class="headerlink" href="#project-information-links" title="Permanent link">¶</a></h3>
+<ul>
+<li><a href="https://wiki.apache.org/incubator/MynewtProposal">Project Proposal</a></li>
+<li><a href="https://issues.apache.org/jira/browse/MYNEWT/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel">Issue Tracking</a></li>
+<li><a href="http://incubator.apache.org/projects/mynewt.html">Project Status</a></li>
+</ul>
+<h3 id="mailing-lists">Mailing Lists<a class="headerlink" href="#mailing-lists" title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p>dev@mynewt.incubator.apache.org </p>
+<p>This is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org.</p>
+</li>
+<li>
+<p>commits@mynewt.incubator.apache.org</p>
+<p>This is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apache.org.</p>
+</li>
+<li>
+<p>notifications@mynewt.incubator.apache.org</p>
+<p>This is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notifications list, send an email to notifications-subscribe@mynewt.incubator.apache.org. </p>
+</li>
+</ul>
+<p>To subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription.</p>
+<h3 id="project-documentation">Project Documentation<a class="headerlink" href="#project-documentation" title="Permanent link">¶</a></h3>
+<p>The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. </p>
<ul>
<li>
-<p><a href="chapter1/newt_concepts/">Chapter 1: Getting Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
+<p><a href="chapter1/newt_concepts/">Chapter 1: Get Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
</li>
<li>
-<p><a href="chapter2/vocabulary/">Chapter 2: Getting Acclimated</a> delves deeper into the concepts crucial to the software development effort. </p>
+<p><a href="chapter2/vocabulary/">Chapter 2: Get Acclimated</a> delves deeper into the concepts crucial to the software development effort. </p>
</li>
<li>
<p><a href="chapter3/newt_ops/">Chapter 3: Newt Tool Reference</a> describes the command structure and details all the available commands to help you with your project. </p>
</li>
-</ul></div>
+<li>
+<p><a href="chapter4/newt_os/">Chapter 4: Newt OS</a> provides an overview of the features available and how to customize for your hardware and software application.</p>
+</li>
+<li>
+<p><a href="chapter5/mods/">Chapter 5: Modules</a> lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.</p>
+</li>
+<li>
+<p><a href="chapter6/dist/">Chapter 6: Creating packages for distribution</a> delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.</p>
+</li>
+</ul>
+<h3 id="contributing-to-documentation">Contributing to Documentation<a class="headerlink" href="#contributing-to-documentation" title="Permanent link">¶</a></h3>
+<p>All content on this site is statically generated using <a href="http://www.mkdocs.org">MkDocs</a> from documents written in Markdown and stored in the <code>docs</code> directory on the master branch in the <a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git">Documentation repository</a>. As a documentation contributor you will modify in the desired markdown file or create new ones in the appropriate chapter subdirectory under <code>docs</code>. </p>
+<p>To edit content in a Markdown file and be able to see how the changes look rendered in html you may use desktop apps such as:</p>
+<ul>
+<li><a href="http://25.io/mou/">Mou</a> for Mac</li>
+<li><a href="http://alternativeto.net/software/mou/?platform=windows">Something like Mou</a> for Windows</li>
+</ul>
+<p>The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.</p>
+<p>You can preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in <a href="http://www.mkdocs.org">MkDocs</a>.</p></div>
</div>
@@ -284,5 +348,5 @@
<!--
MkDocs version : 0.14.0
-Build Date UTC : 2015-11-10 08:04:37.803624
+Build Date UTC : 2015-11-10 08:41:15.724642
-->
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0682ef09/mkdocs/search_index.json
----------------------------------------------------------------------
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index 0ad0f9e..7e6cc2e 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -2,12 +2,12 @@
"docs": [
{
"location": "/",
- "text": "Objective of Mynewt\n\n\nMynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.\n\n\nThe world of Mynewt, therefore, has three primary collaborative goals:\n\n\n\n\nBuild a modularized real-time operating system for a rich set of hardware components\n\n\nOffer a suite of open-source software for efficient and secure two-way communications with an embedded device\n\n\nDevelop method and tools necessary to build an optimized executable image on the desired hardware\n\n\n\n\nThe chapter organization is outlined below. Each Chapter has one or more tutorials for hands-on experience with the material in each chapter. \n\n\n\n\n\n\nChapter 1: Getting Started\n introduces s
ome key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.\n\n\n\n\n\n\nChapter 2: Getting Acclimated\n delves deeper into the concepts crucial to the software development effort. \n\n\n\n\n\n\nChapter 3: Newt Tool Reference\n describes the command structure and details all the available commands to help you with your project.",
+ "text": "Objective of Mynewt\n\n\nMynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.\n\n\nThe world of Mynewt, therefore, has three primary collaborative goals:\n\n\n\n\nBuild a modularized real-time operating system for a rich set of hardware components\n\n\nOffer a suite of open-source software for efficient and secure two-way communications with an embedded device\n\n\nDevelop method and tools necessary to build an op
timized executable image on the desired hardware\n\n\n\n\nProject GIT Repository\n\n\n\n\n\n\nDocumentation repository\n containing the markdown docs that generate the html pages you see here.\n\n\n\n\n\n\nMynewt OS development repository (larva)\n containing all code packages for newt operating system and middleware software being worked on.\n\n\n\n\n\n\nNewt tool development repository (newt)\n containing source code for the newt tool.\n\n\n\n\n\n\nProject Information Links\n\n\n\n\nProject Proposal\n\n\nIssue Tracking\n\n\nProject Status\n\n\n\n\nMailing Lists\n\n\n\n\n\n\ndev@mynewt.incubator.apache.org \n\n\nThis is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org.\n\n\n\n\n\n\ncommits@mynewt.incubator.apache.org\n\n\nThis is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apache.org.\n\n\n\n\n\n\nnoti
fications@mynewt.incubator.apache.org\n\n\nThis is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notifications list, send an email to notifications-subscribe@mynewt.incubator.apache.org. \n\n\n\n\n\n\nTo subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription.\n\n\nProject Documentation\n\n\nThe chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. \n\n\n\n\n\n\nChapter 1: Get Started\n introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.\n\n\n\n\n\n\nChapter 2: Get Acc
limated\n delves deeper into the concepts crucial to the software development effort. \n\n\n\n\n\n\nChapter 3: Newt Tool Reference\n describes the command structure and details all the available commands to help you with your project. \n\n\n\n\n\n\nChapter 4: Newt OS\n provides an overview of the features available and how to customize for your hardware and software application.\n\n\n\n\n\n\nChapter 5: Modules\n lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.\n\n\n\n\n\n\nChapter 6: Creating packages for distribution\n delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.\n\n\n\n\n\n\nContributing to Documentation\n\n\nAll content on this site is statically generated using \nMkDocs\n from documents written in Markdown and stored in the \ndocs\n directory on the master branch in the \nDocumentat
ion repository\n. As a documentation contributor you will modify in the desired markdown file or create new ones in the appropriate chapter subdirectory under \ndocs\n. \n\n\nTo edit content in a Markdown file and be able to see how the changes look rendered in html you may use desktop apps such as:\n\n\n\n\nMou\n for Mac\n\n\nSomething like Mou\n for Windows\n\n\n\n\nThe static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.\n\n\nYou can preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in \nMkDocs\n.",
"title": "Home"
},
{
"location": "/#objective-of-mynewt",
- "text": "Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind. The world of Mynewt, therefore, has three primary collaborative goals: Build a modularized real-time operating system for a rich set of hardware components Offer a suite of open-source software for efficient and secure two-way communications with an embedded device Develop method and tools necessary to build an optimized executable image on the desired hardware The chapter organization is outlined below. Each Chapter has one or more tutorials for hands-on experience with the material in each chapter. Chapter 1: Getting Started introduces some key terms in this initiative and includes a tutorial for a
quick project to show how to work with some of the products. Chapter 2: Getting Acclimated delves deeper into the concepts crucial to the software development effort. Chapter 3: Newt Tool Reference describes the command structure and details all the available commands to help you with your project.",
+ "text": "Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind. The world of Mynewt, therefore, has three primary collaborative goals: Build a modularized real-time operating system for a rich set of hardware components Offer a suite of open-source software for efficient and secure two-way communications with an embedded device Develop method and tools necessary to build an optimized executable image on the desired hard
ware Project GIT Repository Documentation repository containing the markdown docs that generate the html pages you see here. Mynewt OS development repository (larva) containing all code packages for newt operating system and middleware software being worked on. Newt tool development repository (newt) containing source code for the newt tool. Project Information Links Project Proposal Issue Tracking Project Status Mailing Lists dev@mynewt.incubator.apache.org This is for both contributors and users. In order to subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. commits@mynewt.incubator.apache.org This is mainly for contributors to code or documentation. In order to subscribe to the commits list, send an email to commits-subscribe@mynewt.incubator.apache.org. notifications@mynewt.incubator.apache.org This is for all autogenerated mail except commits e.g. JIRA notifications. In order to subscribe to the notificatio
ns list, send an email to notifications-subscribe@mynewt.incubator.apache.org. To subscribe to a mailing list, you simply send an email to a special subscription address. To subscribe to the dev list, send an email to dev-subscribe@mynewt.incubator.apache.org. For the issues list, the address would be issues-subscribe@mynewt.incubator.apache.org. You should then get an automated email which details how to confirm your subscription. Project Documentation The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. Chapter 1: Get Started introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products. Chapter 2: Get Acclimated delves deeper into the concepts crucial to the software development effort. Chapter 3: Newt Tool Reference describes the command structure and details all the available commands to he
lp you with your project. Chapter 4: Newt OS provides an overview of the features available and how to customize for your hardware and software application. Chapter 5: Modules lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components. Chapter 6: Creating packages for distribution delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management. Contributing to Documentation All content on this site is statically generated using MkDocs from documents written in Markdown and stored in the docs directory on the master branch in the Documentation repository . As a documentation contributor you will modify in the desired markdown file or create new ones in the appropriate chapter subdirectory under docs . To edit content in a Markdown file and be able to see how the changes look rendered in html y
ou may use desktop apps such as: Mou for Mac Something like Mou for Windows The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future. You can preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in MkDocs .",
"title": "Objective of Mynewt"
},
{