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/02/25 23:39:18 UTC
incubator-mynewt-site git commit: Updated community page and
contribution steps
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/master be428a55e -> 287136d06
Updated community page and contribution steps
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/287136d0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/287136d0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/287136d0
Branch: refs/heads/master
Commit: 287136d0674f4b873bb94b5c6f6448254d9fbd9b
Parents: be428a5
Author: aditihilbert <ad...@runtime.io>
Authored: Thu Feb 25 14:39:05 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Thu Feb 25 14:39:05 2016 -0800
----------------------------------------------------------------------
custom-theme/community.html | 11 +-
docs/os/get_acclimated/how_to_edit_docs.md | 134 +++++++++++++++++
docs/os/get_acclimated/try_markdown.md | 32 ++++
docs/os/get_started/how_to_edit_docs.md | 187 ------------------------
docs/os/get_started/try_markdown.md | 32 ----
mkdocs.yml | 9 +-
6 files changed, 180 insertions(+), 225 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/287136d0/custom-theme/community.html
----------------------------------------------------------------------
diff --git a/custom-theme/community.html b/custom-theme/community.html
index 548878a..120ec1e 100644
--- a/custom-theme/community.html
+++ b/custom-theme/community.html
@@ -133,12 +133,12 @@
<div class="col-md-12">
<h2>Contributing Code</h2>
<p>
- You get started by submitting patches for your peers to review and merge. After a few patches under your belt you will get access to commit code directly to the module you are working on in the repository. Over time you will get full access to all the repositories and can commit code to any module. </p>
+ You can start contributing right away even if you are not a committer on Apache Mynewt! The proposed workflow is explained <a href="https://git-wip-us.apache.org/docs/workflow.html">here</a>. You essentially submit your edits for your peers to review and merge. After a few patches under your belt you will get access to commit code directly to the module you are working on in the repository. Over time you will get full access to all the repositories and 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:
+ 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>
@@ -152,7 +152,7 @@
<p> One or more committers will review your work, ask for edits or clarifications, and merge when it is ready. </p>
<br>
<li>
- Submit your new code snippet along with a diff from the old code via email to the @dev mailing list. 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.
+ 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>
@@ -170,11 +170,14 @@
<h2>Contributing to the web site</h2>
<p>All content on this site is statically generated using MkDocs from documents written in Markdown and HTML and stored on the master branch in the documentation repository. </p>
<br>
- <p>Click on the tutorial "How to edit docs" under "Get Started", the first chapter in Docs, to learn how to edit a sample file try_markdown.md on Mynewt's documentation git repository. The static html content for this website 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>Click on the tutorial "Edit docs" under "Tutorials" in the Mynewt Manual to learn how to edit a sample file `try_markdown.md` on Mynewt's documentation git repository. The static html content for this website 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>
<br>
<p>If you wish, 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 but described in the tutorial.
</p>
+ <br>
+ <p>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>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/287136d0/docs/os/get_acclimated/how_to_edit_docs.md
----------------------------------------------------------------------
diff --git a/docs/os/get_acclimated/how_to_edit_docs.md b/docs/os/get_acclimated/how_to_edit_docs.md
new file mode 100644
index 0000000..3a08697
--- /dev/null
+++ b/docs/os/get_acclimated/how_to_edit_docs.md
@@ -0,0 +1,134 @@
+## How to Edit Docs
+
+### Objective
+
+Learn the process of editing docs by adding some content to a test document.
+
+### Markdown, MkDocs, Mou
+
+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 [http://www.mkdocs.org](http://www.mkdocs.org). 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).
+
+You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as [Mou](http://25.io/mou/) is enough to check how it will look after the document has gone through MkDocs. Go ahead and download [Mou](http://25.io/mou/). If you are on a Windows machine, download the [editor of your choice](http://alternativeto.net/software/mou/?platform=windows).
+
+Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.
+
+
+### Access to the Apache repo
+
+Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.
+
+If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html). You will find the steps described in more detail later in this tutorial.
+
+### Making a local copy
+
+* 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. Use http instead of https if you are a non-committer.
+```no-highlight
+ $ 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
+```
+* Create a new branch to work on your documentation and move to that branch.
+```no-highlight
+ $ git checkout -b <your-branch-name>
+```
+
+### File to be edited
+
+The file you will edit is named try_markdown.md. It is in the incubator-mynewt-site/docs/os/get_acclimated/ directory.
+
+### Editing an existing page
+
+* Open the application Mou.
+
+* Open the file incubator-mynewt-site/docs/os/get_acclimated/try_markdown.md in Mou.
+
+* Edit the last item on the list.
+
+* Save and quit the application.
+
+### Adding a new page
+
+If you create a new file somewhere in the `docs` subdirectory to add a new page, you have to add a line in the `mkdocs.yml` file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named `ethernet.md` in the `modules` subdirectory, you have to insert the following line under `Modules:` in the `mkdocs.yml` file.
+```no-highlight
+ - 'Ethernet': 'modules/ethernet.md'
+```
+### Pushing changes to remote as a committer
+
+If you are not a committer yet, skip this section and proceed to the [next section](#sharing-changes-as-a-non-committer).
+
+* Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.
+```no-highlight
+ $ 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)
+```
+* If, however, you do not see your remote repository, then set it up as follows.
+
+```no-highlight
+ $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
+```
+* First check the git status. It will show you that the `try_markdown.md` document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository.
+
+ During staging below using `git add`, we use the `-A` option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after `-m`) should summarize what your changes are about.
+```no-highlight
+ $ git status
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+ $ git push -u origin <your-branch-name>
+```
+* You can see the changed Markdown file if you traverse the tree on the git repository [ https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git]( https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git).
+
+* A commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.
+
+### Sharing changes as a non-committer
+
+We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html).
+
+* Assuming you have made changes to the example file, you will first commit your changes.
+```no-highlight
+ $ git add -A
+ $ git commit -m "My first doc change as a trial run"
+```
+* Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future) and email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough.
+
+ If there is a JIRA ticket associated with your work you should post your patch files to the ticket.
+
+```no-highlight
+ $ git format-patch origin/trunk
+```
+
+* Alternatively, you can use the mirror on github.com to submit a pull request. The mirror is located at [https://github.com/apache/incubator-mynewt-site](https://github.com/apache/incubator-mynewt-site). It is up to you to decide whether to create a fork or a branch to work in and submit pull requests from. Your pull request will be reviewed by a committer for docs and merged into the master branch when the changes are understood and accepted.
+
+
+### Conversion to HTML
+
+The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.
+
+### Local preview of HTML files
+
+However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).
+```no-highlight
+ $ python --version
+ Python 2.7.2
+ $ pip --version
+ pip 1.5.2
+ $ pip install mkdocs
+```
+You will then run the built-in webserver from the root of the documentation directory using the command `mkdocs serve`. The root directory for documentation is `incubator-mynewt-site` or the directory with the `mkdocs.yml` file.
+```no-highlight
+ $ ls
+ docs images mkdocs.yml
+ $ mkdocs serve
+```
+Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.
+
+For more information on MkDocs go to [http://www.mkdocs.org](http://www.mkdocs.org).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/287136d0/docs/os/get_acclimated/try_markdown.md
----------------------------------------------------------------------
diff --git a/docs/os/get_acclimated/try_markdown.md b/docs/os/get_acclimated/try_markdown.md
new file mode 100644
index 0000000..e35707c
--- /dev/null
+++ b/docs/os/get_acclimated/try_markdown.md
@@ -0,0 +1,32 @@
+## Try Markdown
+
+### Heading3
+
+#### Heading4
+
+- - -
+
+##### List
+
+* Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).
+
+* Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.
+
+* It's **very** easy to do **bold** and *italics*.
+
+* See how this list has been made using *
+
+* Click on "Help" in Mou and then on "Markdown Syntax Reference".
+
+* <font color="red"> Substitute a sentence of your own here </font>
+
+* <font color="red"> Guinea Pig!!! </font>
+
+---
+
+> <font color="red"> Note! </font>
+>> You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in [how_to_edit_docs.md](how_to_edit_docs.md).
+>>
+>> You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website.
+>>
+>> You do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in [how_to_edit_docs.md](how_to_edit_docs.md).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/287136d0/docs/os/get_started/how_to_edit_docs.md
----------------------------------------------------------------------
diff --git a/docs/os/get_started/how_to_edit_docs.md b/docs/os/get_started/how_to_edit_docs.md
deleted file mode 100644
index 2c30f3e..0000000
--- a/docs/os/get_started/how_to_edit_docs.md
+++ /dev/null
@@ -1,187 +0,0 @@
-## How to Edit Docs
-
-### Objective
-
-We will go through the process of downloading existing doccumentation and adding some content to a test document.
-
-### Markdown, MkDocs, Mou
-
-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 [http://www.mkdocs.org](http://www.mkdocs.org). 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).
-
-You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as [Mou](http://25.io/mou/) is enough to check how it will look after the document has gone through MkDocs. Go ahead and download [Mou](http://25.io/mou/). If you are on a Windows machine, download the [editor of your choice](http://alternativeto.net/software/mou/?platform=windows).
-
-Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.
-
-
-### Access to the Apache repo
-
-Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.
-
-If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html). You will find the steps described in more detail later in this tutorial.
-
-### Making a local copy
-
-* 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. Use http instead of https if you are a non-committer.
-```no-highlight
- $ 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
-```
-* Create a new branch to work on your documentation and move to that branch.
-```no-highlight
- $ git checkout -b <your-branch-name>
-```
-
-### File to be edited
-
-The file you will edit is [try_markdown.md](./try_markdown.md).
-
-### Editing an existing page
-
-* Open the application Mou.
-
-* Open the file incubator-mynewt-site/docs/get_started/try_markdown.md in Mou.
-
-* Edit the last item on the list.
-
-* Save and quit the application.
-
-You may want to review the documentation organization back in [Home](../../index.md) to remind you how to locate files easily. The corresponding directory tree structure is shown below.
-```no-highlight
- .
- ├── docs
- │ ├── get_started
- │ │ ├── how_to_edit_docs.md
- │ │ ├── newt_concepts.md
- │ │ ├── pics
- │ │ │ ├── bottomview.png
- │ │ │ └── topview.png
- │ │ ├── project1.md
- │ │ └── try_markdown.md
- │ ├── get_acclimated
- │ │ ├── project2.md
- │ │ ├── project3.md
- │ │ ├── ... (more to be added)
- │ │ └── vocabulary.md
- │ ├── newt
- │ │ ├── newt_ops.md
- │ │ └── newt_tool_reference.md
- │ ├── os
- │ │ ├── context_switch.md
- │ │ ├── event_queue.md
- │ │ ├── heap.md
- │ │ ├── mbufs.md
- │ │ ├── memory_pool.md
- │ │ ├── mutex.md
- │ │ ├── mynewt_os.md
- │ │ ├── port_os.md
- │ │ ├── sanity.md
- │ │ ├── semaphore.md
- │ │ ├── task.md
- │ │ ├── time.md
- │ │ └── ... (more to be added)
- │ ├── modules
- │ │ ├── bootloader.md
- │ │ ├── console.md
- │ │ ├── filesystem.md
- │ │ ├── shell.md
- │ │ ├── testutil.md
- │ │ └── ... (more to be added)
- │ ├── packaging
- │ │ ├── dist.md
- │ │ └── ... (more to be added)
- │ ├── extra.css
- │ ├── images
- │ │ └── egg-logo.png
- │ └── index.md
- ├── images
- │ ├── asf_logo_wide.gif
- │ ├── content-bg.png
- │ └── egg-logo.png
- ├── mkdocs.yml
-```
-
-### Adding a new page
-
-If you create a new file somewhere in the `docs` subdirectory to add a new page, you have to add a line in the `mkdocs.yml` file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named `ethernet.md` in the `modules` subdirectory, you have to insert the following line under `Modules:` in the `mkdocs.yml` file.
-```no-highlight
- - 'Ethernet': 'modules/ethernet.md'
-```
-### Pushing changes to remote as a committer
-
-If you are not a committer yet, skip this section and proceed to the [next section](#sharing-changes-as-a-non-committer).
-
-* Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.
-```no-highlight
- $ 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)
-```
-* If, however, you do not see your remote repository, then set it up as follows.
-
-```no-highlight
- $ git remote add origin https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git
-```
-* First check the git status. It will show you that the `try_markdown.md` document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository.
-
- During staging below using `git add`, we use the `-A` option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after `-m`) should summarize what your changes are about.
-```no-highlight
- $ git status
- $ git add -A
- $ git commit -m "My first doc change as a trial run"
- $ git push -u origin <your-branch-name>
-```
-* You can see the changed Markdown file if you traverse the tree on the git repository [ https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git]( https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git).
-
-* A commit notification automatically goes out to the commits@mynewt.incubator.apache.org mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.
-
-### Sharing changes as a non-committer
-
-We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is [https://git-wip-us.apache.org/docs/workflow.html](https://git-wip-us.apache.org/docs/workflow.html).
-
-* Assuming you have made changes to the example file, you will first commit your changes.
-```no-highlight
- $ git add -A
- $ git commit -m "My first doc change as a trial run"
-```
-* Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future):
-```no-highlight
- $ git format-patch origin/trunk
-```
-* Email the patch file to dev@mynewt.incubator.apache.org. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough.
-
- If there is a JIRA ticket associated with your work you should post your patch files to the ticket.
-
-
-### Conversion to HTML
-
-The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.
-
-### Local preview of HTML files
-
-However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).
-```no-highlight
- $ python --version
- Python 2.7.2
- $ pip --version
- pip 1.5.2
- $ pip install mkdocs
-```
-You will then run the built-in webserver from the root of the documentation directory using the command `mkdocs serve`. The root directory for documentation is `incubator-mynewt-site` or the directory with the `mkdocs.yml` file.
-```no-highlight
- $ ls
- docs images mkdocs.yml
- $ mkdocs serve
-```
-Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.
-
-For more information on MkDocs go to [http://www.mkdocs.org](http://www.mkdocs.org).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/287136d0/docs/os/get_started/try_markdown.md
----------------------------------------------------------------------
diff --git a/docs/os/get_started/try_markdown.md b/docs/os/get_started/try_markdown.md
deleted file mode 100644
index e35707c..0000000
--- a/docs/os/get_started/try_markdown.md
+++ /dev/null
@@ -1,32 +0,0 @@
-## Try Markdown
-
-### Heading3
-
-#### Heading4
-
-- - -
-
-##### List
-
-* Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).
-
-* Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.
-
-* It's **very** easy to do **bold** and *italics*.
-
-* See how this list has been made using *
-
-* Click on "Help" in Mou and then on "Markdown Syntax Reference".
-
-* <font color="red"> Substitute a sentence of your own here </font>
-
-* <font color="red"> Guinea Pig!!! </font>
-
----
-
-> <font color="red"> Note! </font>
->> You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in [how_to_edit_docs.md](how_to_edit_docs.md).
->>
->> You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website.
->>
->> You do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in [how_to_edit_docs.md](how_to_edit_docs.md).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/287136d0/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index 03321aa..71fa39d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,5 +1,5 @@
site_name: Apache Mynewt
-site_url: http://mynewt.incubator.apache.org
+site_url: http://mynewt.apache.org
theme_dir: 'custom-theme'
@@ -15,8 +15,9 @@ pages:
- 'Blinky, The First Project': 'os/get_started/project1.md'
- 'Understanding Newt Terms': 'os/get_started/vocabulary.md'
- Tutorials:
- - 'Blinky on Real Hardware': 'os/get_acclimated/project2.md'
+ - 'Blinky on More Boards': 'os/get_acclimated/project2.md'
- 'Unit Testing a Package': 'os/get_acclimated/project3.md'
+ - 'Edit Docs': 'os/get_acclimated/how_to_edit_docs.md'
- Manual:
- OS Core:
- OS Fundamentals:
@@ -47,9 +48,11 @@ pages:
- Tasks:
- 'Overview': 'os/core_os/task/task.md'
- 'Functions':
+ - '_clear_stack': 'os/core_os/task/_clear_stack.md'
- 'os_task_count': 'os/core_os/task/os_task_count.md'
- 'os_task_info_get_next': 'os/core_os/task/os_task_info_get_next.md'
- 'os_task_init': 'os/core_os/task/os_task_init.md'
+ - 'os_task_next_id': 'os/core_os/task/os_task_next_id.md'
- 'os_task_sanity_checkin': 'os/core_os/task/os_task_sanity_checkin.md'
- Event Queues:
- 'Overview': 'os/core_os/event_queue/event_queue.md'
@@ -89,6 +92,8 @@ pages:
- Mbufs:
- 'Overview': 'os/core_os/mbuf/mbuf.md'
- 'Functions':
+ - '_os_mbuf_copypkthdr': 'os/core_os/mbuf/_os_mbuf_copypkthdr.md'
+ - '_os_msys_find_pool.md': 'os/core_os/mbuf/_os_msys_find_pool.md'
- 'os_mbuf_adj': 'os/core_os/mbuf/os_mbuf_adj.md'
- 'os_mbuf_append': 'os/core_os/mbuf/os_mbuf_append.md'
- 'os_mbuf_concat': 'os/core_os/mbuf/os_mbuf_concat.md'