mirror of
https://git.rtems.org/rtems-docs/
synced 2025-06-04 17:54:35 +08:00
user: Move support sections to top level
This is a preparation step to move the bug reporting procedure from the wiki to the user manual and to add a contributing section.
This commit is contained in:
Sebastian Huber
parent
8037cbbebc
commit
f170947c00
@ -29,6 +29,7 @@ RTEMS User Manual (|version|).
|
|||||||
|
|
||||||
overview/index
|
overview/index
|
||||||
start/index
|
start/index
|
||||||
|
support/index
|
||||||
hosts/index
|
hosts/index
|
||||||
installation/index
|
installation/index
|
||||||
|
|
||||||
|
|||||||
@ -270,126 +270,6 @@ architecture or BSP. The RTEMS Project encourages users and organizations to
|
|||||||
fill this role for the community. The :ref:`RTEMS Source Builder <RSB>`
|
fill this role for the community. The :ref:`RTEMS Source Builder <RSB>`
|
||||||
provides some aid to :ref:`build and deploy tool binaries <RSBDeployment>`.
|
provides some aid to :ref:`build and deploy tool binaries <RSBDeployment>`.
|
||||||
|
|
||||||
Support
|
|
||||||
=======
|
|
||||||
.. index:: Support
|
|
||||||
|
|
||||||
RTEMS offers a variety of support options.
|
|
||||||
|
|
||||||
This section covers all options available to both users and developers. If you
|
|
||||||
believe this is a bug report please submit it to the bug tracker otherwise the
|
|
||||||
developers mailing list is the default location to send the report.
|
|
||||||
|
|
||||||
RTEMS Project Support
|
|
||||||
---------------------
|
|
||||||
.. index:: RTEMS Project Support
|
|
||||||
|
|
||||||
The following support channels are provided by the RTEMS Project and provide
|
|
||||||
direct access to the RTEMS community.
|
|
||||||
|
|
||||||
Bug Tracker
|
|
||||||
~~~~~~~~~~~
|
|
||||||
.. index:: Bugs
|
|
||||||
.. index:: Reporting bugs
|
|
||||||
|
|
||||||
The bug tracker can be found at the :r:url:`bugs`.
|
|
||||||
|
|
||||||
See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for
|
|
||||||
details on submitting a ticket.
|
|
||||||
|
|
||||||
Be sure to do a cursory search for any tickets that may be relevant to your
|
|
||||||
problem.
|
|
||||||
|
|
||||||
If you are unsure about your issue status submit a ticket and we will help you
|
|
||||||
sort it out.
|
|
||||||
|
|
||||||
Documentation
|
|
||||||
~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
The latest user documentation can always be found at the :r:url:`docs`.
|
|
||||||
|
|
||||||
.. _support-mailing-lists:
|
|
||||||
|
|
||||||
Mailing Lists
|
|
||||||
~~~~~~~~~~~~~
|
|
||||||
.. index:: Community
|
|
||||||
.. index:: Mailing lists
|
|
||||||
|
|
||||||
We have several mailing lists for RTEMS users and developers.
|
|
||||||
|
|
||||||
* :r:list:`announce`
|
|
||||||
* Announcements for major and other project-related issues.
|
|
||||||
|
|
||||||
* :r:list:`bugs`
|
|
||||||
* Bugs email from :r:url:`bugs`.
|
|
||||||
|
|
||||||
* :r:list:`devel`
|
|
||||||
* Developers list, this is for developers of RTEMS itself.
|
|
||||||
|
|
||||||
|
|
||||||
* :r:list:`build`
|
|
||||||
* Results from the testing and building of RTEMS.
|
|
||||||
|
|
||||||
* :r:list:`users`
|
|
||||||
* Users of RTEMS.
|
|
||||||
|
|
||||||
* :r:list:`vc`
|
|
||||||
* Commits to the RTEMS master repository.
|
|
||||||
|
|
||||||
|
|
||||||
IRC
|
|
||||||
~~~
|
|
||||||
.. index:: Community
|
|
||||||
.. index:: IRC
|
|
||||||
|
|
||||||
RTEMS IRC is available on the Freenode network. See the `Freenode
|
|
||||||
<http://www.freenode.net/>`_ web site for details on connecting, selecting a
|
|
||||||
nickname, and general usage tips. If you are new to IRC it is recommended
|
|
||||||
reading.
|
|
||||||
|
|
||||||
These are the current IRC channels.
|
|
||||||
|
|
||||||
**#rtems**
|
|
||||||
|
|
||||||
This is a general channel for all things RTEMS. You can just hang out with
|
|
||||||
other RTEMS users and developers to talk about RTEMS, using RTEMS or to make
|
|
||||||
contact with other RTEMS users.
|
|
||||||
|
|
||||||
The ``#rtems`` channel is logged. You can find the logs at
|
|
||||||
http://www.rtems.org/irclogs/. You can search the logs using Google by adding:
|
|
||||||
|
|
||||||
**site:rtems.org inurl:irclogs**
|
|
||||||
|
|
||||||
to your search terms.
|
|
||||||
|
|
||||||
Developers
|
|
||||||
~~~~~~~~~~
|
|
||||||
.. index:: Community
|
|
||||||
.. index:: Developers
|
|
||||||
|
|
||||||
Developers can find help and support on the mailing lists, see
|
|
||||||
:ref:`support-mailing-lists`.
|
|
||||||
|
|
||||||
Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be
|
|
||||||
found on the :r:url:`devel`.
|
|
||||||
|
|
||||||
Commercial Support Services
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
The wider RTEMS community has developers and organizations who can provide
|
|
||||||
commercial support services. These services range from training, implementing
|
|
||||||
new features in RTEMS, deployment of RTEMS< helping establish a new project
|
|
||||||
environment for a team, to application and system design.
|
|
||||||
|
|
||||||
The RTEMS Project does not endorse or promote any provider of these services
|
|
||||||
and we recommend you use a search engine to locate a suitable provider. If you
|
|
||||||
are unsure please contact a provider and see what is available.
|
|
||||||
|
|
||||||
If you develop a new feature or you have someone do this for you we recommend
|
|
||||||
you have the work submitted to the project and merged. Once accepted into the
|
|
||||||
project the work will be maintained as part of the development process within
|
|
||||||
the project and this is a benefit for.
|
|
||||||
|
|
||||||
Real-time Application Systems
|
Real-time Application Systems
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
|
|||||||
22
user/support/bugs.rst
Normal file
22
user/support/bugs.rst
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2019 embedded brains GmbH
|
||||||
|
.. Copyright (C) 2019 Sebastian Huber
|
||||||
|
.. Copyright (C) 2016 Chris Johns <chrisj@rtems.org>
|
||||||
|
|
||||||
|
.. index:: bugs
|
||||||
|
.. index:: reporting bugs
|
||||||
|
|
||||||
|
Bugs
|
||||||
|
****
|
||||||
|
|
||||||
|
The bug tracker can be found at the :r:url:`bugs`.
|
||||||
|
|
||||||
|
See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for
|
||||||
|
details on submitting a ticket.
|
||||||
|
|
||||||
|
Be sure to do a cursory search for any tickets that may be relevant to your
|
||||||
|
problem.
|
||||||
|
|
||||||
|
If you are unsure about your issue status submit a ticket and we will help you
|
||||||
|
sort it out.
|
||||||
15
user/support/contrib.rst
Normal file
15
user/support/contrib.rst
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2019 embedded brains GmbH
|
||||||
|
.. Copyright (C) 2019 Sebastian Huber
|
||||||
|
.. Copyright (C) 2016 Chris Johns <chrisj@rtems.org>
|
||||||
|
|
||||||
|
.. index:: community; developers
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
************
|
||||||
|
|
||||||
|
Developers can find help and support on the :r:list:`devel`.
|
||||||
|
|
||||||
|
Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be
|
||||||
|
found on the :r:url:`devel`.
|
||||||
16
user/support/index.rst
Normal file
16
user/support/index.rst
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2019 embedded brains GmbH
|
||||||
|
.. Copyright (C) 2019 Sebastian Huber
|
||||||
|
|
||||||
|
.. index:: support
|
||||||
|
|
||||||
|
Support and Contributing
|
||||||
|
************************
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
|
||||||
|
support-project
|
||||||
|
bugs
|
||||||
|
contrib
|
||||||
|
support-commercial
|
||||||
22
user/support/support-commercial.rst
Normal file
22
user/support/support-commercial.rst
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2016 Chris Johns <chrisj@rtems.org>
|
||||||
|
|
||||||
|
.. index:: support; commercial
|
||||||
|
|
||||||
|
Commercial Support Services
|
||||||
|
***************************
|
||||||
|
|
||||||
|
The wider RTEMS community has developers and organizations who can provide
|
||||||
|
commercial support services. These services range from training, implementing
|
||||||
|
new features in RTEMS, deployment of RTEMS, helping establish a new project
|
||||||
|
environment for a team, to application and system design.
|
||||||
|
|
||||||
|
The RTEMS Project does not endorse or promote any provider of these services
|
||||||
|
and we recommend you use a search engine to locate a suitable provider. If you
|
||||||
|
are unsure please contact a provider and see what is available.
|
||||||
|
|
||||||
|
If you develop a new feature or you have someone do this for you we recommend
|
||||||
|
you have the work submitted to the project and merged. Once accepted into the
|
||||||
|
project the work will be maintained as part of the development process within
|
||||||
|
the project and this is a benefit for.
|
||||||
80
user/support/support-project.rst
Normal file
80
user/support/support-project.rst
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
.. Copyright (C) 2019 embedded brains GmbH
|
||||||
|
.. Copyright (C) 2019 Sebastian Huber
|
||||||
|
.. Copyright (C) 2016 Chris Johns <chrisj@rtems.org>
|
||||||
|
|
||||||
|
.. index:: support; RTEMS Project
|
||||||
|
|
||||||
|
RTEMS Project Support
|
||||||
|
*********************
|
||||||
|
|
||||||
|
.. index:: community; users mailing list
|
||||||
|
.. index:: mailing lists; users
|
||||||
|
|
||||||
|
Users Mailing List
|
||||||
|
==================
|
||||||
|
|
||||||
|
RTEMS offers a variety of support options and ways to contribute to the
|
||||||
|
project. Users can ask their questions on the :r:list:`users`. This is a low
|
||||||
|
frequency mailing list intended for topics related to the use of RTEMS. If you
|
||||||
|
are new to RTEMS, please join the list and ask whatever you want.
|
||||||
|
|
||||||
|
.. index:: documentation
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
|
You find the latest set of manuals at the :r:url:`docs`.
|
||||||
|
|
||||||
|
.. index:: mailing lists; announce
|
||||||
|
.. index:: mailing lists; bugs
|
||||||
|
.. index:: mailing lists; build
|
||||||
|
.. index:: mailing lists; devel
|
||||||
|
.. index:: mailing lists; vc
|
||||||
|
|
||||||
|
All Mailing Lists
|
||||||
|
=================
|
||||||
|
|
||||||
|
We have several mailing lists for RTEMS users and developers:
|
||||||
|
|
||||||
|
* :r:list:`announce`: Announcements for major and other project-related issues.
|
||||||
|
|
||||||
|
* :r:list:`bugs`: Emails generated by the :r:url:`bugs`.
|
||||||
|
|
||||||
|
* :r:list:`devel`: For developers of RTEMS itself.
|
||||||
|
|
||||||
|
* :r:list:`build`: Results from building and testing of RTEMS.
|
||||||
|
|
||||||
|
* :r:list:`users`: For users of RTEMS.
|
||||||
|
|
||||||
|
* :r:list:`vc`: Commits to the RTEMS Project repositories.
|
||||||
|
|
||||||
|
IRC
|
||||||
|
===
|
||||||
|
|
||||||
|
.. index:: community; IRC
|
||||||
|
.. index:: IRC
|
||||||
|
|
||||||
|
RTEMS IRC is available on the Freenode network. See the `Freenode
|
||||||
|
<http://www.freenode.net/>`_ web site for details on connecting, selecting a
|
||||||
|
nickname, and general usage tips. If you are new to IRC it is recommended
|
||||||
|
reading.
|
||||||
|
|
||||||
|
These is currently only one IRC channel available for RTEMS:
|
||||||
|
|
||||||
|
**#rtems**
|
||||||
|
|
||||||
|
This is a general channel for all things RTEMS. You can just hang out with
|
||||||
|
other RTEMS users and developers to talk about RTEMS, using RTEMS or to make
|
||||||
|
contact with other RTEMS users.
|
||||||
|
|
||||||
|
The ``#rtems`` channel is logged. You can find the logs at:
|
||||||
|
|
||||||
|
http://www.rtems.org/irclogs/
|
||||||
|
|
||||||
|
You can search the logs using Google by adding
|
||||||
|
|
||||||
|
**site:rtems.org inurl:irclogs**
|
||||||
|
|
||||||
|
to your search terms.
|
||||||
Loading…
x
Reference in New Issue
Block a user