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:32:06 UTC
[17/18] incubator-mynewt-site git commit: Added content in the Quick
Start page, fixed relative links, cleaned community page
Added content in the Quick Start page, fixed relative links, cleaned community page
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/cb552868
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/cb552868
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/cb552868
Branch: refs/heads/master
Commit: cb55286867e05446d6d816f0de7b20c695b6b122
Parents: a62d00f
Author: aditihilbert <ad...@runtime.io>
Authored: Fri May 20 00:02:03 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri May 20 00:02:03 2016 -0700
----------------------------------------------------------------------
custom-theme/about.html | 22 +---------
custom-theme/community.html | 58 ++++++-------------------
custom-theme/download.html | 2 +-
custom-theme/main-banner.html | 2 +-
custom-theme/quick-start.html | 12 ++---
custom-theme/secondary-banner.html | 12 +++++
docs/about.md | 6 +--
docs/community.md | 2 +-
docs/events.md | 2 +-
docs/os/introduction.md | 15 +++++--
docs/os/tutorials/project-slinky.md | 6 +--
docs/os/tutorials/project-target-slinky.md | 8 ++--
docs/quick-start.md | 30 +++++++++++++
mkdocs.yml | 22 +++++-----
14 files changed, 100 insertions(+), 99 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/custom-theme/about.html
----------------------------------------------------------------------
diff --git a/custom-theme/about.html b/custom-theme/about.html
index e809196..471a5be 100644
--- a/custom-theme/about.html
+++ b/custom-theme/about.html
@@ -1,25 +1,9 @@
{% include 'main-banner.html' %}
-<div class="container">
- <div class="row">
- <div class="column col-md-12">
-
-<div class="bg-orange padded event-callout content">
- <div class="row">
- <div class="col-md-12 text-center">
- <h3>Pre-GA release version of Mynewt 0.8.0 with BLE 4.2 support is available now. </h3>
- <p> <a href="http://mynewt.apache.org/download/"> Download! </a> </p>
- </div>
- </div>
- </div>
- </div>
- </div>
-</div>
-
<div class="container small-no-padding">
<div class="row">
<div class="col-md-8 content">
- <h1> Features </h1>
+ <h3> Features </h3>
<li>
Real-time operating system kernel (Mynewt OS)
</li>
@@ -46,7 +30,7 @@
</p>
</div>
<div class="col-md-4">
- <h1> Git Repos </h1>
+ <h3> Source Code on github.com </h3>
<li>
<a href="https://github.com/apache/incubator-mynewt-core"> Git repo for Mynewt OS </a>
</li>
@@ -56,8 +40,6 @@
<li>
<a href="https://github.com/apache/incubator-mynewt-site"> Git repo for Docs </a>
</li>
- <h1> Quick Start <h1>
- <a href="/os/get_started/get_started/"> Setup for Project Blinky! </a>
</div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/custom-theme/community.html
----------------------------------------------------------------------
diff --git a/custom-theme/community.html b/custom-theme/community.html
index 50fbb63..06616c1 100644
--- a/custom-theme/community.html
+++ b/custom-theme/community.html
@@ -1,17 +1,4 @@
{% include 'main-banner.html' %}
- <div class="container">
- <div class="row">
- <div class="col-md-12 text-center">
-
-<div class="bg-orange padded event-callout content">
- <h3> Welcome to the community!</h3>
- <br>
- <p> Questions? Join the dev@ mailing list. </p>
- <p> Want Mynewt 0.8.0 with BLE 4.2 support? <a href="http://mynewt.apache.org/download"> Download! </a> </p>
- </div>
- </div>
- </div>
-</div>
<div class="container small-no-padding">
@@ -62,34 +49,24 @@
<p> <a href="http://mail-archives.apache.org/mod_mbox/incubator-mynewt-notifications/">Mail archives</a> </p>
</div>
</div>
- </div>
+ </div>
</div>
-
<div class="container">
<div class="row">
<div class="col-md-12">
- <h2>Bug Submission and Issue Tracking</h2>
+ <h3>Bug Submission and Issue Tracking</h3>
<p>Issues, features, improvements, and wish-lists are tracked using <a href="https://issues.apache.org/jira/browse/Mynewt/">ASF JIRA</a>, the Atlassian JIRA software on Apache Software Foundation </p>
<li>
Sign up for an account on JIRA and submit a request to the dev@ mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project. Editing a ticket requires an account.
</li>
<li> Log in and report a bug by choosing the "MYNEWT" project, clicking on the "Create" button, and creating a ticket with an appropriate Issue Type (e.g. Bug, Wish). </p>
- <p> If you are a contributor and wish to work on a change, open a JIRA ticket first. It's always a good idea to introduce the change in the dev@ mailing list and refer to that ticket. When you generate a pull request into the github mirror for your change, always reference the JIRA ticket number in the title. JIRA is set up to resolve the ticket when your code is merged into the ASF git repository and the pull request closed.
- </div>
- </div>
- </div>
-
+ <p> If you are a contributor and wish to work on a change, open a JIRA ticket first. It's always a good idea to introduce the change in the dev@ mailing list and refer to that ticket. When you generate a pull request into the github mirror for your change, always reference the JIRA ticket number in the title. JIRA is set up to resolve the ticket when your code is merged into the ASF git repository and the pull request closed. </p>
-<a name="Contributing Code"></a>
-
-<div class="container">
- <div class="row">
- <div class="col-md-12">
- <h2>Contributing Code</h2>
- <p>
+ <h3>Contributing Code</h3>
+ <p>
You can start contributing right away, even if you are not a committer on Apache Mynewt! One requirement is that you adhere to the Apache's proposed workflow as explained <a href="https://git-wip-us.apache.org/docs/workflow.html">here</a>. Basically, you submit your initial edits for your peers to review and merge. After a few successful patches under your belt, you will get access to commit code directly to the module you are working on in the repository. And over time, you will get full access to all the repositories, where you can commit code to any module. </p>
- <p>You may choose to submit patches in one of the two following ways: </p>
+ <p>You may choose to submit patches in one of the two following ways:
<br>
<ol>
<li>
@@ -105,26 +82,17 @@
</ul>
<p>In the comment for the pull request, include a description of the changes you have made and why. Github will automatically notify everyone on the commits@mynewt.incubator.apache.org mailing list about the newly opened pull requests. You can open a pull request even if you don't think the code is ready for merging but want some discussion on the matter. </p>
<p> Upon receiving notification, one or more committers will review your work, ask for edits or clarifications, and merge when your proposed changes are ready.</p>
- <br>
+ </li>
<li>
- Use the `git format-patch` command to produce a patch file. Submit the patch (your code changes along with a diff from the old code) via email to the @dev mailing list. Summarize the issue and your work in the email. Regular project members will review your suggested patch and add it to the repository, acknowledging your contribution by referencing your name in the commit message.
- </li>
- <br>
-
- </div>
- </div>
- </div>
-</div>
-
-<div class="container">
-<div class="row">
- <div class="col-md-12">
- <h2>Contributing to the web site</h2>
+ Use the `git format-patch` command to produce a patch file. Submit the patch (your code changes along with a diff from the old code) via email to the @dev mailing list. Summarize the issue and your work in the email. Regular project members will review your suggested patch and add it to the repository, acknowledging your contribution by referencing your name in the commit message. </li>
+ </ol>
+ </p>
+
+ <h3>Contributing to the web site</h3>
<p> Go to <a href="https://github.com/apache/incubator-mynewt-site">Apache Mynewt documentation repo mirrored on github</a> to clone the repository into a local branch on your machine. Make your changes. Then submit a pull request on the github mirror repository by clicking the green "New pull request" button on the page. </p>
<p> To know more check out the <a href="http://mynewt.apache.org/faq/how_to_edit_docs/"> Appendix </a>. </p>
<br>
- </div>
+
</div>
</div>
</div>
-
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/custom-theme/download.html
----------------------------------------------------------------------
diff --git a/custom-theme/download.html b/custom-theme/download.html
index 856160b..58caa97 100644
--- a/custom-theme/download.html
+++ b/custom-theme/download.html
@@ -1,4 +1,4 @@
-{% include 'main-banner.html' %}
+{% include 'secondary-banner.html' %}
<div class="container">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/custom-theme/main-banner.html
----------------------------------------------------------------------
diff --git a/custom-theme/main-banner.html b/custom-theme/main-banner.html
index 86428a4..3dea9d3 100644
--- a/custom-theme/main-banner.html
+++ b/custom-theme/main-banner.html
@@ -7,7 +7,7 @@
</div><!-- (need this comment because of the inline-blocks)
--><div class="col-md-4 v2-vcenter">
<div class="news bg-orange text-center">
- <h4>Pre-GA release version of Mynewt 0.8.0 with BLE 4.2 support is available now. </h4>
+ <h4>Pre-GA Mynewt 0.8.0 release is available now. </h4>
<a href="/download/">Download!</a>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/custom-theme/quick-start.html
----------------------------------------------------------------------
diff --git a/custom-theme/quick-start.html b/custom-theme/quick-start.html
index 3211d56..aa9748b 100644
--- a/custom-theme/quick-start.html
+++ b/custom-theme/quick-start.html
@@ -1,13 +1,15 @@
-{% include 'main-banner.html' %}
+{% include 'secondary-banner.html' %}
<div class="container v2-quick-start">
+ <div class="container small-no-padding">
<div class="row">
- <div class="col-md-12">
- <p>
- Here goes some quick start content.
- </p>
+ <div class="col-md-12 content">
+ {% block content %}
+ {{ content }}
+ {% endblock %}
</div>
</div>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/custom-theme/secondary-banner.html
----------------------------------------------------------------------
diff --git a/custom-theme/secondary-banner.html b/custom-theme/secondary-banner.html
new file mode 100644
index 0000000..6c36a9d
--- /dev/null
+++ b/custom-theme/secondary-banner.html
@@ -0,0 +1,12 @@
+<div class="container">
+ <div class="row v2-main-banner">
+ <div class="col-md-8 v2-vcenter">
+ <img class="logo" src="/img/logo.svg">
+ <h4 class="tagline">Modular OS to operate an IoT network</h4>
+ </div><!-- (need this comment because of the inline-blocks)
+ --><div class="col-md-4 v2-vcenter">
+ </div>
+
+
+ </div>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/about.md
----------------------------------------------------------------------
diff --git a/docs/about.md b/docs/about.md
index 926834e..327074d 100644
--- a/docs/about.md
+++ b/docs/about.md
@@ -1,4 +1,4 @@
-#Roadmap
+###Roadmap
Release Version | Descriptor | Date |Features
@@ -25,7 +25,7 @@ Release Version | Descriptor | Date |Features
<br>
-#Feature Request
+###Feature Request
The WISHLIST at the top of the roadmap on [JIRA for Mynewt](https://issues.apache.org/jira/browse/MYNEWT/?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel) features all the new ideas awaiting discussion and review. Once the community decides to go ahead with a request, it is scheduled into a release. Generally, effort is made to schedule a requested feature into a particular version no later than 6 weeks prior to the planned release date.
@@ -33,7 +33,7 @@ If you have suggestions for a new feature, use case, or implementation improveme
<br>
-#FAQ
+###FAQ
<font color="#F2853F"> Questions? </font> Click [here](faq/answers.md)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/community.md
----------------------------------------------------------------------
diff --git a/docs/community.md b/docs/community.md
index 219341d..0b004a4 100644
--- a/docs/community.md
+++ b/docs/community.md
@@ -1,6 +1,6 @@
-##Mailing Lists
+###Mailing Lists
We welcome you to join our mailing lists and get in touch with us!
<font color="#F2853F"> *To complete your subscription you have to confirm it by replying to the response sent to you when you email your subscription request!* </font>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/events.md
----------------------------------------------------------------------
diff --git a/docs/events.md b/docs/events.md
index 34e741a..7d2e2f9 100644
--- a/docs/events.md
+++ b/docs/events.md
@@ -1,3 +1,3 @@
-#Events
+###Events
Please take a look at our upcoming events! We hope to see you there.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/os/introduction.md
----------------------------------------------------------------------
diff --git a/docs/os/introduction.md b/docs/os/introduction.md
index 09240e5..22df5c9 100644
--- a/docs/os/introduction.md
+++ b/docs/os/introduction.md
@@ -50,13 +50,22 @@ 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).
+You can install and build *newt* for [Linux](..//newt/install/newt_linux/) or [Mac](../newt/install/newt_mac/).
+
+<br>
+
+### Newt Manager ###
+
+
+In order to enable a user to communicate with remote instances of Mynewt OS and query, configure, and operate them, Mynewt provides an application tool called Newt Manager or `newtmgr`.
+
+You can install and build *newtmgr* from source code on [Linux or Mac](../newtmgr/installing/).
<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.
+With the introductions out of the way, now is a good time to [get set up and
+started](../get_started/get_started/) with your first Mynewt application.
Happy Hacking!
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/os/tutorials/project-slinky.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/project-slinky.md b/docs/os/tutorials/project-slinky.md
index f084939..2949437 100644
--- a/docs/os/tutorials/project-slinky.md
+++ b/docs/os/tutorials/project-slinky.md
@@ -25,16 +25,16 @@ The instructions assume the user is using a Bourne-compatible shell (e.g. bash o
### Installing newt
If you have not already installed `newt` see the
-[newt installation instructions](../../newt/install/newt_mac.md) and ensure newt is installed an in your path.
+[newt installation instructions](../get_started/get_started/) and ensure newt is installed an in your path.
### Installing newtmgr
If you have not already installed `newtmgr` see the
-[newtmgr installation instructions](../../newtmgr/installing.md) and ensure newtmgr is installed an in your path.
+[newtmgr installation instructions](../../newtmgr/installing/) and ensure newtmgr is installed an in your path.
### Creating a new project
-Instructions for creating a project are located in the [Getting Started](../get_started/project_create.md) section of the [Mynewt OS Manual](../get_started/introduction.md)
+Instructions for creating a project are located in the [Basic Setup](../get_started/project_create/) section of the [Mynewt Documentation](../introduction/)
We will list only the steps here for brevity. We will name the project
`slinky`.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/os/tutorials/project-target-slinky.md
----------------------------------------------------------------------
diff --git a/docs/os/tutorials/project-target-slinky.md b/docs/os/tutorials/project-target-slinky.md
index 927c4e0..e51b8d6 100644
--- a/docs/os/tutorials/project-target-slinky.md
+++ b/docs/os/tutorials/project-target-slinky.md
@@ -29,18 +29,18 @@ The instructions assume the user is using a Bourne-compatible shell (e.g. bash o
### Install newt
If you have not already installed `newt`, see the
-[newt installation instructions](../../newt/install/newt_mac.md) and ensure newt is installed an in your path.
+[newt installation instructions](../get_started/get_started/) and ensure newt is installed an in your path.
### Install newtmgr
If you have not already installed `newtmgr`, see the
-[newtmgr installation instructions](../../newtmgr/installing.md) and ensure newtmgr is installed an in your path.
+[newtmgr installation instructions](../../newtmgr/installing/) and ensure newtmgr is installed an in your path.
### Create a new project
-Instructions for creating a project are located in the [Getting Started](../get_started/project_create.md) section of the [Mynewt OS Manual](../get_started/introduction.md).
+Instructions for creating a project are located in the [Basic Setup](../get_started/project_create/) section of the [Mynewt Documentation](../introduction.md).
-If you already completed [sim slinky](project-slinky.md) you can skip this step.
+If you already completed [Sim Slinky](project-slinky.md) you can skip this step.
We will list only the steps here for brevity. We will name the project
`slinky`.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/docs/quick-start.md
----------------------------------------------------------------------
diff --git a/docs/quick-start.md b/docs/quick-start.md
index e69de29..6b54cfb 100644
--- a/docs/quick-start.md
+++ b/docs/quick-start.md
@@ -0,0 +1,30 @@
+### Get set
+
+Apache Mynewt currently offers two ways to quickly get set up, each appealing to different personal preference and familiarity with embedded systems.
+
+<br>
+
+* **Option 1:** All-in-one docker container that bundles Newt tool, developer toolchains and libraries. For this option, go to [Docker instructions](../os/get_started/docker/)
+
+* **Option 2:** Step-by-step instructions to install the Newt tool, developer toolchains and libraries natively on your computer. For this option, go to [Native Setup](../os/get_started/native_tools/)
+
+<br>
+
+### Go!
+
+Start a new project as explained under [Create Your First Project](../os/get_started/project_create/). The core Mynewt OS is automatically downloaded as part of the project installation.
+
+<br>
+
+* When you [Create Your First Project](../os/get_started/project_create/) you define a simulated target and run Project Blinky, the Hello World equivalent in the embedded world.
+
+* If you have one of the supported [boards](../), you can make real LEDs blink in [Project Blinky](../os/tutorials/arduino_zero/). Simply choose the appropriate tutorial for the board and proceed.
+
+<br>
+
+### And More...
+
+Explore the [Tutorials](../os/tutorials/tutorials/) section for other interesting projects or simply to learn more about Mynewt's capabilities and get familiar with its use.
+
+<br>
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/cb552868/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index 2d8ff29..42d213c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -14,8 +14,8 @@ pages:
- toc: 'os/introduction.md'
- Basic Setup:
- toc: 'os/get_started/get_started.md'
- - 'Option 1, Single Docker Container': 'os/get_started/docker.md'
- - 'Option 2, Native installs':
+ - 'Docker Container Option': 'os/get_started/docker.md'
+ - 'Native install Option':
- 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'
@@ -24,11 +24,12 @@ pages:
- Concepts: 'os/get_started/vocabulary.md'
- Tutorials:
- toc: 'os/tutorials/tutorials.md'
- - 'Blinky on Arduino Zero': 'os/tutorials/arduino_zero.md'
- - 'Blinky on Olimex': 'os/tutorials/olimex.md'
- - 'Blinky on STM32F303': 'os/tutorials/STM32F303.md'
- - 'Blinky on nRF52': 'os/tutorials/nRF52.md'
- - 'Run Blinky from SRAM, no bootloader': 'os/tutorials/blinky_sram_olimex.md'
+ - 'Project Blinky':
+ - 'Blinky on Arduino Zero': 'os/tutorials/arduino_zero.md'
+ - 'Blinky on Olimex': 'os/tutorials/olimex.md'
+ - 'Blinky on STM32F303': 'os/tutorials/STM32F303.md'
+ - 'Blinky on nRF52': 'os/tutorials/nRF52.md'
+ - 'Run Blinky from SRAM, no bootloader': 'os/tutorials/blinky_sram_olimex.md'
- 'Add repo to project': 'os/tutorials/add_repos.md'
- 'Create a repo': 'os/tutorials/create_repo.md'
- 'Upgrade a repo': 'os/tutorials/upgrade_repo.md'
@@ -306,10 +307,7 @@ pages:
- 'json_encode_object_finish': 'os/modules/json/json_encode_object_finish.md'
- 'json_encode_object_key': 'os/modules/json/json_encode_object_key.md'
- 'json_encode_object_start': 'os/modules/json/json_encode_object_start.md'
-# - 'json_encode_value': 'os/modules/json/json_encode_value.md'
-# - 'json_read_array': 'os/modules/json/json_read_array.md'
- 'json_read_object': 'os/modules/json/json_read_object.md'
-# - 'json_target_address': 'os/modules/json/json_target_address.md'
- Stats:
- toc: 'os/modules/stats/stats.md'
- Logs:
@@ -333,7 +331,7 @@ 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:
+ - Newt Tool Guide:
- toc: 'newt/newt_intro.md'
- Newt Theory of Ops: 'newt/newt_operation.md'
- Command Guide:
@@ -353,7 +351,7 @@ pages:
- '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:
+ - Newt Manager Guide:
- toc: 'newtmgr/overview.md'
- 'Install': 'newtmgr/installing.md'
- Appendix: