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 2018/10/15 19:58:43 UTC
[mynewt-site] branch master updated: Adding v1_4_0 and pointing
latest to master
This is an automated email from the ASF dual-hosted git repository.
aditi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-site.git
The following commit(s) were added to refs/heads/master by this push:
new 046702d Adding v1_4_0 and pointing latest to master
046702d is described below
commit 046702de51ac8764f2f4cf52d991b5e841a346d4
Author: Aditi Hilbert <ad...@runtime.io>
AuthorDate: Mon Oct 15 12:57:59 2018 -0700
Adding v1_4_0 and pointing latest to master
---
custom-theme/choose_doc_version.html | 6 +++
mkdocs.yml | 3 ++
versions/v1_4_0/custom-theme | 1 +
versions/v1_4_0/docs/about.md | 25 +++++++++
versions/v1_4_0/docs/community.md | 8 +++
versions/v1_4_0/docs/documentation.md | 30 +++++++++++
versions/v1_4_0/docs/download.md | 75 ++++++++++++++++++++++++++
versions/v1_4_0/docs/events.md | 3 ++
versions/v1_4_0/docs/extra.css | 19 +++++++
versions/v1_4_0/docs/images/egg-logo2.png | Bin 0 -> 7241 bytes
versions/v1_4_0/docs/index.md | 1 +
versions/v1_4_0/docs/known_issues.md | 18 +++++++
versions/v1_4_0/docs/news/article1.md | 0
versions/v1_4_0/docs/pages/ble.md | 8 +++
versions/v1_4_0/docs/pages/configurability.md | 8 +++
versions/v1_4_0/docs/pages/securitybullets.md | 8 +++
versions/v1_4_0/docs/quick-start.md | 29 ++++++++++
versions/v1_4_0/docs/talks.md | 0
mkdocs.yml => versions/v1_4_0/mkdocs.yml | 5 +-
19 files changed, 246 insertions(+), 1 deletion(-)
diff --git a/custom-theme/choose_doc_version.html b/custom-theme/choose_doc_version.html
index fa8f7b5..2192075 100644
--- a/custom-theme/choose_doc_version.html
+++ b/custom-theme/choose_doc_version.html
@@ -6,6 +6,12 @@
Version: master
</option>
<option
+ value="/v1_4_0/os/introduction"
+ {% if config.extra.version == "v1_4_0" %}selected="selected"{% endif %}
+ >
+ Version: 1.4.0
+ </option>
+ <option
value="/v1_3_0/os/introduction"
{% if config.extra.version == "v1_3_0" %}selected="selected"{% endif %}
>
diff --git a/mkdocs.yml b/mkdocs.yml
index d8439fe..83f2c62 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -51,6 +51,9 @@ extra:
- label: '1.3.0'
dir: 'v1_3_0'
latest: False
+ - label: '1.4.0'
+ dir: 'v1_4_0'
+ latest: False
doc_path: 'latest'
events:
event 1:
diff --git a/versions/v1_4_0/custom-theme b/versions/v1_4_0/custom-theme
new file mode 120000
index 0000000..9f2a9e2
--- /dev/null
+++ b/versions/v1_4_0/custom-theme
@@ -0,0 +1 @@
+../../custom-theme
\ No newline at end of file
diff --git a/versions/v1_4_0/docs/about.md b/versions/v1_4_0/docs/about.md
new file mode 100644
index 0000000..61e3cea
--- /dev/null
+++ b/versions/v1_4_0/docs/about.md
@@ -0,0 +1,25 @@
+### Roadmap
+
+Some upcoming features:
+
+* Full IP support
+* Low power support with ability for drivers to turn on/off low power settings automatically
+* Sensor API, see [discussion thread](https://lists.apache.org/list.html?dev@mynewt.apache.org:dfr=June%201|dto=2016-11-14:%22Sensor%20Drivers%22)
+* Support for MIPS architecture
+* Support for additional boards
+
+<font color="#F2853F"> The detailed roadmap is tracked on [JIRA for Mynewt](https://issues.apache.org/jira/browse/MYNEWT/?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel). </font>
+
+<br>
+
+### 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.
+
+If you have suggestions for a new feature, use case, or implementation improvements, file a JIRA ticket with Issue Type set to "Wish". Introduce it in the [dev@](dev@mynewt.incubator.apache.org) mailing list with a link to the JIRA ticket. This assumes you have signed up for an account on JIRA and submitted a request to the dev@ mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project.
+
+<br>
+
+### FAQ
+
+<font color="#F2853F"> Questions? </font> Click [here](/latest/mynewt_faq.html)
diff --git a/versions/v1_4_0/docs/community.md b/versions/v1_4_0/docs/community.md
new file mode 100644
index 0000000..4257233
--- /dev/null
+++ b/versions/v1_4_0/docs/community.md
@@ -0,0 +1,8 @@
+
+
+### 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>
+
+
diff --git a/versions/v1_4_0/docs/documentation.md b/versions/v1_4_0/docs/documentation.md
new file mode 100644
index 0000000..99d7e68
--- /dev/null
+++ b/versions/v1_4_0/docs/documentation.md
@@ -0,0 +1,30 @@
+# Apache Mynewt Documentation
+
+* Latest version:
+ * [master](/latest/)
+* Earlier versions:
+ * [1.4.0](/v1_4_0/os/introduction/)
+ * [1.3.0](/v1_3_0/os/introduction/)
+ * [1.2.0](/v1_2_0/os/introduction/)
+ * [1.1.0](/v1_1_0/os/introduction/)
+ * [1.0.0](/v1_0_0/os/introduction/)
+ * [0.9.0](/v0_9_0/os/introduction/)
+
+## Documentation Source
+
+<div class="alert alert-info" role="alert">
+Apache Mynewt documentation is undergoing a reorganization. Please check with project committers
+for the best location to make changes in order to avoid duplication of effort.
+</div>
+
+* The most recent project documentation can be found in the apache/mynewt-documentation repo.
+ * [https://github.com/apache/mynewt-documentation](https://github.com/apache/mynewt-documentation)
+ * This holds content like tutorials, FAQs, etc. i.e. content that may change as software changes and can therefore
+ be pinned to a particular release version.
+* Specific code documentation is found in each of the apache/mynewt-\* code repos under /docs.
+ * e.g. [https://github.com/apache/mynewt-core/tree/master/docs](https://github.com/apache/mynewt-core/tree/master/docs)
+* 1.3.0 and earlier documentation is maintained in the apache/mynewt-site repo.
+ * [https://github.com/apache/mynewt-site](https://github.com/apache/mynewt-site)
+ * This will eventually be used only for site pages. i.e. content relating to the project that is not dependent on
+ a software release like the home page, community, events and quick start.
+ * It will also contain earlier versions of the full documentation set until such time as they become obsolete.
diff --git a/versions/v1_4_0/docs/download.md b/versions/v1_4_0/docs/download.md
new file mode 100644
index 0000000..68a60fa
--- /dev/null
+++ b/versions/v1_4_0/docs/download.md
@@ -0,0 +1,75 @@
+## Latest Apache Mynewt OS Release
+
+### Latest Apache Mynewt Core OS Release
+
+* Release Version: Apache Mynewt 1.4.1
+* Release Date: July 1, 2018
+* [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.4.1)
+* [Release Download](http://www.apache.org/dyn/closer.lua/mynewt/apache-mynewt-1.4.1)
+
+### Latest Apache Mynewt NimBLE (Bluetooth Stack) Release
+
+Mynewt's Bluetooth stack is now a separate release with a porting layer that allows it to be easily ported to another OS!
+
+* Release Version: Apache NimBLE 1.0.0
+* Release Date: June 13, 2018
+* [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.4.0)
+* [Release Download](http://www.apache.org/dyn/closer.lua/mynewt/apache-mynewt-1.4.0)
+
+#### Fresh install
+
+If you are brand new to Mynewt, go to [Quick Start](/latest/get_started/). The Newt tool will automatically download the latest release.
+
+If you have already installed the Newt tool but not started any project yet, go to [Create Your First Project](/latest/get_started/project_create.html). The Newt tool will automatically download the latest release.
+
+#### Upgrade
+
+If you have already installed the Newt tool and started a project that installed a previous version of Apache Mynewt, upgrade using Newt tool:
+
+```
+$ newt upgrade
+```
+
+### Code in development
+
+While the use of one of the official releases listed above is generally recommended, you may be interested in seeing work in progress.
+
+The most recent code that is fairly stable over the full OS resides in the `master` branch of the Mynewt git repository. You may view or fork the repositories for Mynewt OS and Newt Tool from the Apache mirror on github.com.
+
+* [Apache Mynewt OS mirror on github.com](https://github.com/apache/incubator-mynewt-core/tree/master)
+* [Apache Newt Tool mirror on github.com](https://github.com/apache/incubator-mynewt-newt/tree/master)
+
+The most recent code to support a major feature (e.g. Bluetooth 5) can be found in a long-lived feature branch dedicated to that feature (bluetooth5, in the example for Bluetooth 5) and not the master. If you are interested in seeing the latest code for that feature, you can clone the desired branch using git:
+
+```
+$ git clone git://github.com/apache/incubator-mynewt-core.git -b <feature-branch-name>
+$ git clone git://github.com/apache/incubator-mynewt-newt.git -b <feature-branch-name>
+```
+
+<br>
+
+For general information on using Git at Apache, go to https://git-wip-us.apache.org.
+
+<br>
+
+### Prior Releases
+
+#### Apache Mynewt Core
+
+* Apache Mynewt 0.8.0-b2-incubating, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-0.8.0-b2-incubating), [Release Archive](https://archive.apache.org/dist/incubator/mynewt/apache-mynewt-0.8.0-b2-incubating/)
+* Apache Mynewt 0.8.0-incubating, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-0.8.0-incubating), [Release Archive](https://archive.apache.org/dist/incubator/mynewt/apache-mynewt-0.8.0-incubating/)
+* Apache Mynewt 0.9.0-incubating, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-0.9.0-incubating), [Release Archive](https://archive.apache.org/dist/incubator/mynewt/apache-mynewt-0.9.0-incubating/)
+* Apache Mynewt 1.0.0-b1-incubating, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.0.0-b1-incubating), [Release Archive](https://archive.apache.org/dist/incubator/mynewt/apache-mynewt-1.0.0-b1-incubating/)
+* Apache Mynewt 1.0.0-b2-incubating, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.0.0-b2-incubating), [Release Archive](https://archive.apache.org/dist/incubator/mynewt/apache-mynewt-1.0.0-b2-incubating/)
+* Apache Mynewt 1.0.0-incubating, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.0.0-incubating), [Release Archive](https://archive.apache.org/dist/incubator/mynewt/apache-mynewt-1.0.0-incubating/)
+* Apache Mynewt 1.1.0, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.1.0), [Release Archive](https://archive.apache.org/dist/mynewt/apache-mynewt-1.1.0/)
+* Apache Mynewt 1.2.0, [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.2.0), [Release Archive](https://archive.apache.org/dist/mynewt/apache-mynewt-1.2.0/)
+* Apache Mynewt 1.3.0 [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.3.0), [Release Archive](http://www.apache.org/dyn/closer.lua/mynewt/apache-mynewt-1.3.0)
+* Apache Mynewt 1.4.0 [Release Notes](https://cwiki.apache.org/confluence/display/MYNEWT/RN-1.4.0), [Release Archive](http://www.apache.org/dyn/closer.lua/mynewt/apache-mynewt-1.4.0)
+
+#### Apache Mynewt NimBLE (Bluetooth Stack)
+
+No archives yet
+
+<br>
+<br>
diff --git a/versions/v1_4_0/docs/events.md b/versions/v1_4_0/docs/events.md
new file mode 100644
index 0000000..b2f8e9d
--- /dev/null
+++ b/versions/v1_4_0/docs/events.md
@@ -0,0 +1,3 @@
+### Events
+
+Please take a look at our upcoming events! We hope to see you there.
diff --git a/versions/v1_4_0/docs/extra.css b/versions/v1_4_0/docs/extra.css
new file mode 100644
index 0000000..27164a3
--- /dev/null
+++ b/versions/v1_4_0/docs/extra.css
@@ -0,0 +1,19 @@
+
+/*
+ * Fix wrapping in the code highlighting
+ *
+ * https://github.com/mkdocs/mkdocs/issues/233
+ */
+code {
+ white-space: pre;
+}
+
+/*
+ * Wrap inline code samples otherwise they shoot off the side and
+ * can't be read at all.
+ *
+ * https://github.com/mkdocs/mkdocs/issues/313
+ */
+p code {
+ word-wrap: break-word;
+}
diff --git a/versions/v1_4_0/docs/images/egg-logo2.png b/versions/v1_4_0/docs/images/egg-logo2.png
new file mode 100644
index 0000000..9d25899
Binary files /dev/null and b/versions/v1_4_0/docs/images/egg-logo2.png differ
diff --git a/versions/v1_4_0/docs/index.md b/versions/v1_4_0/docs/index.md
new file mode 100644
index 0000000..bc1906c
--- /dev/null
+++ b/versions/v1_4_0/docs/index.md
@@ -0,0 +1 @@
+Apache Mynewt is a real-time, modular operating system for connected IoT devices that need to operate for long periods of time under power, memory, and storage constraints. The first connectivity stack offered is BLE 4.2.
diff --git a/versions/v1_4_0/docs/known_issues.md b/versions/v1_4_0/docs/known_issues.md
new file mode 100644
index 0000000..37146e1
--- /dev/null
+++ b/versions/v1_4_0/docs/known_issues.md
@@ -0,0 +1,18 @@
+## Known Issues
+
+Here is a list of known issues and workarounds:
+
+1. `newt install` returns the following error:
+
+ ReadDesc: No matching branch for apache-mynewt-core repo
+ No matching branch for apache-mynewt-core repo
+
+ The apache-mynewt-core Git repository location has changed due to Mynewt's graduation from an incubator project to an Apache top level project. The HTTP redirect to the new location may fail for some users.
+
+ **Workaround:** Edit the `project.yml` file and change the line `repo: incubator-mynewt-core` as shown in the following example to `repo: mynewt-core`:
+
+ repository.apache-mynewt-core:
+ type: github
+ vers: 1-latest
+ user: apache
+ repo: incubator-mynewt-core
diff --git a/versions/v1_4_0/docs/news/article1.md b/versions/v1_4_0/docs/news/article1.md
new file mode 100644
index 0000000..e69de29
diff --git a/versions/v1_4_0/docs/pages/ble.md b/versions/v1_4_0/docs/pages/ble.md
new file mode 100644
index 0000000..251db32
--- /dev/null
+++ b/versions/v1_4_0/docs/pages/ble.md
@@ -0,0 +1,8 @@
+html: pages/ble.html
+sub_page: True
+
+<!--
+## Markdown
+
+You could make a page with markdown but then you will need to add a {{ content }} to your pages/whatever.html.
+-->
diff --git a/versions/v1_4_0/docs/pages/configurability.md b/versions/v1_4_0/docs/pages/configurability.md
new file mode 100644
index 0000000..58025cf
--- /dev/null
+++ b/versions/v1_4_0/docs/pages/configurability.md
@@ -0,0 +1,8 @@
+html: pages/configurability.html
+sub_page: True
+
+<!--
+## Markdown
+
+You could make a page with markdown but then you will need to add a {{ content }} to your pages/whatever.html.
+-->
diff --git a/versions/v1_4_0/docs/pages/securitybullets.md b/versions/v1_4_0/docs/pages/securitybullets.md
new file mode 100644
index 0000000..792b488
--- /dev/null
+++ b/versions/v1_4_0/docs/pages/securitybullets.md
@@ -0,0 +1,8 @@
+html: pages/securitybullets.html
+sub_page: True
+
+<!--
+## Markdown
+
+You could make a page with markdown but then you will need to add a {{ content }} to your pages/whatever.html.
+-->
diff --git a/versions/v1_4_0/docs/quick-start.md b/versions/v1_4_0/docs/quick-start.md
new file mode 100644
index 0000000..c133f9c
--- /dev/null
+++ b/versions/v1_4_0/docs/quick-start.md
@@ -0,0 +1,29 @@
+### Get set
+
+Apache Mynewt currently offers two ways to quickly get set up, each appealing to different personal preferences and levels of familiarity with embedded systems.
+
+<br>
+
+* **Option 1:** Step-by-step instructions to install the Newt tool, developer toolchains and libraries natively on your computer. This is the recommended option. For this option, go to [Native Setup](/latest/get_started/native_install/)
+
+* **Option 2:** All-in-one docker container that bundles Newt tool, developer toolchains and libraries. This option is only for a quick look at the project. For this option, go to [Docker instructions](/latest/get_started/docker.html)
+
+<br>
+
+### Go!
+
+Start a new project as explained under [Create Your First Project](/latest/get_started/project_create.html). The core Mynewt OS is automatically downloaded as part of the project installation.
+
+<br>
+
+* When you [Create Your First Project](/latest/get_started/project_create.html) 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](/latest/tutorials/blinky/blinky.html). Simply choose the appropriate tutorial for the board and proceed.
+
+<br>
+
+### And More...
+
+Explore the [Tutorials](/latest/tutorials/tutorials.html) section for other interesting projects or simply to learn more about Mynewt's capabilities and get familiar with its use.
+
+<br>
diff --git a/versions/v1_4_0/docs/talks.md b/versions/v1_4_0/docs/talks.md
new file mode 100644
index 0000000..e69de29
diff --git a/mkdocs.yml b/versions/v1_4_0/mkdocs.yml
similarity index 94%
copy from mkdocs.yml
copy to versions/v1_4_0/mkdocs.yml
index d8439fe..5f657a8 100644
--- a/mkdocs.yml
+++ b/versions/v1_4_0/mkdocs.yml
@@ -30,7 +30,7 @@ markdown_extensions:
pygments_style: xcode
extra:
- version: 'master'
+ version: 'v1_4_0'
versions:
- label: 'master'
dir: 'master'
@@ -51,6 +51,9 @@ extra:
- label: '1.3.0'
dir: 'v1_3_0'
latest: False
+ - label: '1.4.0'
+ dir: 'v1_4_0'
+ latest: False
doc_path: 'latest'
events:
event 1: