You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by dmatrix <gi...@git.apache.org> on 2016/02/26 02:59:08 UTC
[GitHub] incubator-mynewt-site pull request: Community Page
GitHub user dmatrix opened a pull request:
https://github.com/apache/incubator-mynewt-site/pull/10
Community Page
Made changes to the community page in my branch jules_mynewt, after cloning the master.
1. Removed redundancy
2. Changed to active voice
3. Minor edits
{% include 'main-banner.html' %}
<div class="bg-orange padded">
<div class="container">
<div class="row">
<div class="col-md-12">
<h1>Welcome to the community!</h1>
<p>We are happy to see you here and appreciate your time and effort. Your contributions are welcome, as we depend on the community's collaboration to make this a viable OS for constrained and embedded enviroments. If you want to learn how to contribute code, please click <a href="#Contributing Code">here</a>.</p>
</div>
</div>
</div>
</div>
<div class="container small-no-padding">
<div class="row content">
<div class="col-md-12">
{% block content %} {{ content }} {% endblock %}
</div>
</div>
<div class="row">
<div class="col-md-6 mailing-list">
<div class="bg-purple mailing-list-title">
Dev Mailing List
</div>
<div class="list-info">
<p><a class="bold-link" href="mailto:dev@mynewt.incubator.apache.org">dev@mynewt.incubator.apache.org</a></p>
<p>For both contributors and users.</p>
</div>
<div class="bg-grey subscribe">
Subscribe
</div>
<div class="list-info">
<p><a href="mailto:dev-subscribe@mynewt.incubator.apache.org">dev-subscribe@mynewt.incubator.apache.org</a></p>
</div>
<div class="bg-grey subscribe">
Unsubscribe
</div>
<div class="list-info">
<p><a href="mailto:dev-unsubscribe@mynewt.incubator.apache.org">dev-unsubscribe@mynewt.incubator.apache.org</a></p>
</div>
</div>
<div class="col-md-6 mailing-list">
<div class="bg-purple mailing-list-title">
Commits Mailing List
</div>
<div class="list-info">
<p><a class="bold-link" href="mailto:commits@mynewt.incubator.apache.org">commits@mynewt.incubator.apache.org</a></p>
<p>Mainly for contributors to code or documentation.</p>
</div>
<div class="bg-grey subscribe">
Subscribe
</div>
<div class="list-info">
<p><a href="mailto:commits-subscribe@mynewt.incubator.apache.org">commits-subscribe@mynewt.incubator.apache.org</a></p>
</div>
<div class="bg-grey subscribe">
Unsubscribe
</div>
<div class="list-info">
<p><a href="mailto:commits-unsubscribe@mynewt.incubator.apache.org">commits-unsubscribe@mynewt.incubator.apache.org</a></p>
</div>
</div>
</div>
<div class="row">
<div class="col-md-6 mailing-list">
<div class="bg-purple mailing-list-title">
Notifications Mailing List
</div>
<div class="list-info">
<p><a class="bold-link" href="mailto:notifications@mynewt.incubator.apache.org">notifications@mynewt.incubator.apache.org</a></p>
<p>For all autogenerated mail except commits e.g. JIRA notifications.</p>
</div>
<div class="bg-grey subscribe">
Subscribe
</div>
<div class="list-info">
<p><a href="mailto:notifications-subscribe@mynewt.incubator.apache.org">notifications-subscribe@mynewt.incubator.apache.org</a></p>
</div>
<div class="bg-grey subscribe">
Unsubscribe
</div>
<div class="list-info">
<p><a href="mailto:notifications-unsubscribe@mynewt.incubator.apache.org">notifications-unsubscribe@mynewt.incubator.apache.org</a></p>
</div>
</div>
</div>
</div>
<div class="content">
<div class="container">
<div class="row">
<div class="col-md-12">
<h2>Mail Archives</h2>
<p>At any point you may peruse archived email exchanges on these mailing lists:
<li>
<a href="http://mail-archives.apache.org/mod_mbox/incubator-mynewt-dev/">For dev@mynewt.incubator.apache.org</a> </p>
</li>
<li>
<a href="http://mail-archives.apache.org/mod_mbox/incubator-mynewt-commits/">For commits@mynewt.incubator.apache.org</a> </p>
</li>
</div>
</div>
</div>
</div>
<div class="content">
<div class="container">
<div class="row">
<div class="col-md-12">
<h2>Issue Tracking</h2>
<p>Issues, features, improvements, and wish-lists are tracked using the Atlassian JIRA software on Apache Software Foundation:
<li>
<a href="https://issues.apache.org/jira/browse/Mynewt/">ASF JIRA</a> </p>
</li>
</div>
</div>
</div>
</div>
<a name="Contributing Code"></a>
<br>
<div class="bg-purple padded">
<div class="container">
<div class="row">
<div class="col-md-12">
<h2>Contributing Code</h2>
<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>
<br>
<ol>
<li>
Clone the repository into a local branch on your machine and make your changes. Then submit a pull request on the github mirror of the appropriate Apache Mynewt repository by clicking the green "New pull request" button on the page:
<ul>
<br>
<li><a href="https://github.com/apache/incubator-mynewt-larva">Apache Mynewt larva repo mirrored on github</a></li>
<br>
<li><a href="https://github.com/apache/incubator-mynewt-newt">Apache Mynewt newt tool repo mirrored on github</a></li>
<br>
<li><a href="https://github.com/apache/incubator-mynewt-site">Apache Mynewt documentation repo mirrored on github</a></li>
<br>
</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>
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="padded">
<div class="container">
<div class="row">
<div class="col-md-12">
<h2>Contributing to the web site</h2>
<p>A build script, using MkDocs utility for Markdown and HTML pages, statically generates all content on this site and stores it on the master branch in the documentation repository once a day.
This content is maintained in the `asf-site` branch in the documentation repository. For now the build scripts generates all the static content once a day, but we will automate it in the future.</p>
<br>
<p>If you wnat to edit any documentation, follow <i>Docs->Apache Mynewt Manual->Tutorials->Edit Docs </i>path from the top-level navigational menu. Then try a sample file `try_markdown.md` on Mynewt's documentation git repository.
</p>
<br>
<p>Also, you may preview the changes you have made on your desktop by installing MkDocs and starting up its builtin webserver as described in MkDocs. This step is optional, even though it's described in the tutorial.
</p>
<br>
<p>One thing to note that if you are not a committer on Apache Mynewt, you cannot push changes to the site repository directly. You will have to work with the mirror on github.com. 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>
</div>
</div>
</div>
</div>
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/apache/incubator-mynewt-site master
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-mynewt-site/pull/10.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #10
----
commit a2a7fbc2c8a490b5a3d14de0507ec9bd836d3b13
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-06T22:45:46Z
investigating website issues
commit 58084c84c9985d3556d71bd308a025f368c4aed8
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-08T00:16:47Z
turning on analytics
commit 62cd55ee73777850fc79e56c6c1473212e595738
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-13T18:08:10Z
fix second level navigation in the docs
commit 2e215108bae24fd2325ab21c8ed58eb4891bd49b
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-13T23:12:51Z
First stab at adding documentation for os_eventq.
commit 770ff4003786c49a1c9dbe8e3ec3de34560aa033
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-13T23:52:43Z
code syntax highlighting removed for event_queue doc except one example
commit 14c4fb91aa0e12ae873956c1c59c81ff5a22ad1f
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-14T18:21:01Z
A bit of documentation for os_callout.
commit 352ff3792d972f9f64ed4f65152a7b2ac2a6a134
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-14T18:23:41Z
Use ```no-highlight instead of ```no-c
commit 1876cfedd3afe00cbe1b3f306e19c8390c5a0776
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-14T19:49:28Z
Document memory pools.
commit 855e435c80c505b5a9f023f402e8b8af978c22a8
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-14T22:09:19Z
Document os_malloc(), os_free().
commit c15f7bf2946784882ef4074f8a2885768c40bbfe
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-15T08:27:07Z
documentation of heap, memory, file system and formatting fixes
commit c851c1fb961edce6dc8b27b01ed3eec92406cef6
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-23T01:44:41Z
Added framework and some details for nffs and fs
commit 82387d6e0ee95ceb1c13a836204567bcfeba9f0c
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-25T20:51:04Z
Explain where to choose which console egg to use. Add a comment
about blocking vs non-blocking transmit. Add notes to console_queue_char()
warning about console output from inside interrupt handlers.
commit acb72bdfb53abf47d06abf7871748de66fdf6fa2
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-25T22:25:50Z
Document shell_cmd_register().
commit 61525081fcf1ae4a6764e38f0ecf35afd2e032b5
Author: Marko Kiiskila <ma...@runtime.io>
Date: 2016-01-25T23:06:36Z
Add some additional notes regarding API functions.
commit 307c1fb34c53120f94ce36ddeabf9e3dfa013aaf
Author: aditihilbert <ad...@runtime.io>
Date: 2016-01-27T17:58:55Z
fixed git repo link
commit c0e21b8965257d7ea249364952e1ab7afee0c65f
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-08T19:38:07Z
update issue tracking info in community.html and add newtmgr doc including project slinky
commit 1ecfc9edaeb75bdf49bac870801fa771ce30428f
Author: spoonofpower <sp...@gmail.com>
Date: 2016-02-12T20:42:41Z
Show spinner when waiting for search results
This closes #1
commit 097f9fc62fb65c50a0ea451006ea1a9910af3cdb
Author: spoonofpower <sp...@gmail.com>
Date: 2016-02-12T23:04:01Z
Use relative paths
This will allow browsing a local dev instance without being taken to
http://mynewt.incubator.apache.org.
This closes #2
commit 77d84dd1c99a7786764d10243cd848c8aa4bc7d0
Author: spoonofpower <sp...@gmail.com>
Date: 2016-02-12T23:22:09Z
Script for generating static site
This captures the steps that are currently done manually.
commit e6344cb55cec13bd4720cc7ce4dd8fc116fb9de0
Author: spoonofpower <sp...@gmail.com>
Date: 2016-02-12T23:28:40Z
Vanity import domain for go code
commit 3b78b5489ff33fa9b0b8a522b8d3bd0d321b365e
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-14T02:20:54Z
Merge branch 'build_script' of https://github.com/spoonofpower/incubator-mynewt-site
This closes #3
commit 658daa27c4e2c5feebb14a2e9a99715bacbe10ff
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-17T18:42:31Z
Added patch commit process for new contributors under community
commit 29070c75c2087325cfd948fa2e98ee12ade77554
Author: spoonofpower <sp...@gmail.com>
Date: 2016-02-17T04:08:50Z
Support nested toc on /documentation page
The /documentation page lists the toplevel links under each chapter.
This change handles the case where a toplevel link is for a nested
section by traversing the tree until a url is found.
For example:
Chapter 1:
- a: url1
- b:
- b1:
-bb2:
-bbb1: url2
-bbb2: url3
-bb3: url4
- b2: url5
- c: url6
The /documentation page will show this
Chapter 1
a
b
c
The link for section b will go to bbb1 (url2)
This commit is accepted from pull request #4 spoonofpower:nested
commit 287038a40088b1e08aae02d79903a4224b47fa42
Author: spoonofpower <sp...@gmail.com>
Date: 2016-02-16T17:19:22Z
Initial support for unlimited toc nesting
This closes #4
commit d253eed6ba148a003aa13e2ff54d45824f77e6e4
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-17T20:29:11Z
added nested TOC for console
commit 87e9d34c3c84678331253d540b6c6e6b2a01befc
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-19T17:18:16Z
adding more function pages for bootloader, testutil, json, and image manager
commit 9b0bc2e09cf22ff7fb00f3b0bd43aab846294af7
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-20T02:51:49Z
added pages for the Core OS functions
commit ab0a92946e7369210719d055ff96b367500f12f0
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-20T05:24:56Z
arranged 3 manuals in 3 columns under docs
commit e2bd22eec0a28b029564fb7fb3f873749c9c6dff
Author: aditihilbert <ad...@runtime.io>
Date: 2016-02-20T21:26:21Z
Updated documentation page introduction to introduce the three manuals
commit dc31af3ffb125ef23374e5349ebfbe349cc8c9c9
Author: Sterling Hughes <st...@apache.org>
Date: 2016-02-22T05:38:30Z
update structure of documentation.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request: Community Page
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-mynewt-site/pull/10
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-mynewt-site pull request: Community Page
Posted by aditihilbert <gi...@git.apache.org>.
Github user aditihilbert commented on the pull request:
https://github.com/apache/incubator-mynewt-site/pull/10#issuecomment-189413589
You have to fork the mirror and push your changes to it. Then you have to generate the pull request from that fork. This pull request will not be merged.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---