Skip to end of metadata
Go to start of metadata

index.rst


index.rst
.. ===============LICENSE_START=======================================================
.. Acumos
.. ===================================================================================
.. Copyright (C) <CURRENT YEAR> <YOUR COMPANY> All rights reserved.
.. ===================================================================================
.. This Acumos documentation file is distributed by <YOUR COMPANY NAME(S)>
.. under the Creative Commons Attribution 4.0 International License (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..  
..      http://creativecommons.org/licenses/by/4.0
..  
.. This file is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ===============LICENSE_END=========================================================

*** don't forget to update the year and company in the license above ***

====================================
<The name of your project goes here>
====================================

.. toctree::
       :maxdepth: 2

       release-notes
       developer-guide
       user-guide
	   

* :ref:`search`

Put the name of your project after the license. The project name, which is the title of the documentation, is between lines of "=" signs. The equal signs must be the exact length as the title text.

The index file is the table of contents for the docs in your project. You can have directories within your docs folder. If you have a tutorials directory with an additional index file, your top-level index.rst would look like this:

index.rst with tutorial directory
.. ===============LICENSE_START=======================================================
.. Acumos
.. ===================================================================================
.. Copyright (C) <CURRENT YEAR> <YOUR COMPANY> All rights reserved.
.. ===================================================================================
.. This Acumos documentation file is distributed by <YOUR COMPANY NAME(S)>
.. under the Creative Commons Attribution 4.0 International License (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..  
..      http://creativecommons.org/licenses/by/4.0
..  
.. This file is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ===============LICENSE_END=========================================================

=============================
Acumos Onboarding Application
=============================


.. toctree::
       :maxdepth: 2

       release-notes
       developer-guide
       user-guide
       tutorials/index

* :ref:`search`

release-notes.rst

Release notes should be meaningful to people who don't work on the project. Please be as descriptive as possible!

Also, if you include a list of Jira items, please include a hyperlink to the actual item in Jira.

release-notes
.. ===============LICENSE_START=======================================================
.. Acumos
.. ===================================================================================
.. Copyright (C) <CURRENT YEAR> <YOUR COMPANY>. All rights reserved.
.. ===================================================================================
.. This Acumos documentation file is distributed by <YOUR COMPANY NAME(S)>
.. under the Creative Commons Attribution 4.0 International License (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..  
..      http://creativecommons.org/licenses/by/4.0
..  
.. This file is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ===============LICENSE_END=========================================================

==============================
<component name> Release Notes
==============================

Version 0.1, 15 February 2018
=============================


* Add method to get solution revision comment count (`ACUMOS-1270 <https://jira.acumos.org/browse/ACUMOS-1270/>`_)
* Show exception details in log files (`ACUMOS-1328 <https://jira.acumos.org/browse/ACUMOS-1328/>`_)
* Requires database schema version 1.15

developer-guide.rst

Like the User Guide, the contents of the Developer Guide will vary based on the complexity of your project. This guide should contain detailed technical information relevant to developers who want to work on your project. Please see the Content Guide for a template and guidelines.


user-guide.rst

The contents of the User Guide will vary depending on the complexity of your project. Please see the Content Guide for a template and guidelines.

  • No labels