Commit Graph

24 Commits

Author SHA1 Message Date
Anas Nashif 81b272119a docs: fixed documenation pointers
Fixed URL to documentation, now latest docs are under /latest/..
Fixes #9932

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-09-12 12:03:18 -04:00
David B. Kinder 1d1a4b321b doc: fix misspellings in reST files
Fix misspellings missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-28 13:59:38 -04:00
David B. Kinder f6349c88af doc: simplify CONTRIBUTING, merge non-apache
Simplify the CONTRIBUTING file seen when submitting a PR, make
references to the full contributing documentation, and merge the
contributing non-apache licensed material.

fixes: #6188

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 22:15:49 -04:00
David B. Kinder c5615aada4 doc: change https://zephyrproject.org/doc refs
Remove extra indirection to documentation (and required
server link redirection) from https://zephyrproject.org/doc/...
to http://docs.zephyrproject.org/...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-02 18:32:44 -04:00
David B. Kinder a380dce018 doc: fix links to mailing lists
A recent LF change to the Zephyr mailing list hosting software changed
the mailing list names and links to the message archives.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-04-21 06:55:46 -07:00
Iván Sánchez Ortega 504686053e doc: Fix path in documentation about uncrustify.cfg
The location of the uncrustify.cfg file was changed in commit
fdadb501f7 , but the documentation
referring to that file was left pointing at the old path.

Signed-off-by: Iván Sánchez Ortega <ivan@sanchezortega.es>
2018-04-13 15:34:43 -04:00
David B. Kinder a02e78d3fd doc: fix note for forcing a CI recheck
Doc incorrectly said to use the word "retest" in a comment when the
correct word is "recheck".

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-04-10 18:27:15 -04:00
Anas Nashif a706a68741 doc: add test coverage and proposal policy
Provide some details about submitting proposals and document that new
major features require tests to be added.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-03-11 05:11:58 -04:00
David B. Kinder 540efaf402 doc: fix misspellings in docs
regular spell check on .rst files found a few misspelled words

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-02-22 15:28:20 -05:00
David B. Kinder cf04bd9e9d doc: fix broken link in contributing guidelines
Link to the implicit target of a doc title wasn't correct

Fixes: #6324
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-02-22 14:13:41 -05:00
Carles Cufi 1a5133ccd0 doc: contributing: Document CI
Add basic CI documentation to help users navigate through the CI system
and deal with failures.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-14 12:54:21 -05:00
Carles Cufi f982a89c4f doc: contributing: Make instructions cross-platform
The contributing instructions were currently centered exclusively around
Linux. Make them generic and cross-plaform while highlighting the tools
that do not currently work on Windows, namely:

 * sanitycheck
 * checkpatch

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-14 12:54:21 -05:00
David B. Kinder 23c6095ebf doc: update CONTRIBUTING guidelines
Commit messages now require a body summary (before it could be blank for
"trivial" changes).

Add mention of uncrustify to help format code to project standards.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-02-09 22:48:56 -05:00
Sebastian Bøe 270deade0e doc: checkpatch: Fix pre-commit hook
The pre-commit hook was or'ing with true and therefore never
triggering when there were checkpatch errors.

Also;

Documented that the file needs to be made executable.

Made it more clear that the file is located in the zephyr git
directory.

Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2018-01-03 13:15:14 -05:00
Marti Bolivar 1948f8b0f0 CONTRIBUTING.rst: add note about idling on IRC
Make sure it's clear that IRC is not an instant-response medium.

Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2017-11-13 13:50:55 -08:00
Sebastian Bøe 7cc2071f71 doc: Remove all mentions of --ccache
Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-11-09 17:55:30 -05:00
Anas Nashif 602a14365d doc: update with CMake instructions
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-11-08 20:00:22 -05:00
Christoph Sax 885f0b469f doc: fix link to DCO in contribution guidelines
The link to the DCO section in the contribution guidelines was pointing
to nowhere. It is replaced by an automated cross-reference in case the
DCO should change in the future.

Signed-off-by: Christoph Sax <c_sax@mailbox.org>
2017-11-05 08:20:14 -05:00
David B. Kinder fafff0fa78 doc: update links to new zephyrproject.org site
Fix links to content on the new version of zephyrproject.org that moved.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-11-03 19:31:14 -04:00
Anas Nashif 37b9ee0b57 doc: reference github issues instead of jira
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-03 12:09:02 -04:00
David B. Kinder 10b24a87fc doc: add contributing non-Apache2.0 docs
Add contribution process for including non-Apache 2.0 components
as approved by the TSC.  Include a README template that lists
information requested by the TSC and governing board for review.
Add a brief mention in the CONTRIBUTING link that appears when
submitting a new PR or Issue via the GitHub web interface.

Included an introduction to the process steps that includes using the
zephyr devel mailing list to discuss new components.

fixes #1543

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-09-22 08:39:38 -04:00
Anas Nashif 788ca64c25 doc: require license information for external code
Contributions of 3rd party code and external HALS should have
information about the license of the code being contributed.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-08-03 11:48:55 -04:00
Anas Nashif 454d0afd49 doc: contribute: fix code block for git hook
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-08-01 15:34:10 -04:00
David B. Kinder 2d4728d52e doc: add CONTRIBUTING.rst to project repo and docs
GitHub notices a CONTRIBUTING file in a repo's root and will
automatically
add a link to this file on the page when a contributor creates an Issue
or opens a Pull Request. (Expectation is CONTRIBUTING will have
information about how to contribute to the project, format code,
test fixes, and submit patches.

We also want to have this document accessible from our technical docs,
and not duplicate the content, so add linkage to make this work.

The zephyrproject github wiki article that contributed to this new
CONTRIBUTING doc will be made into a reference to this new doc once
this PR is approved and merged.

Replaces PR #929

Jira: ZEP-2085

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-07-30 20:41:43 -04:00