Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CON-305: Update documentation #194

Merged
merged 7 commits into from
Mar 8, 2024
Merged

CON-305: Update documentation #194

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bdf273a
CON-305: Update documentation
Alxe Mar 8, 2024
2bfad95
CON-305: Update Readme
Alxe Mar 8, 2024
009cd69
CON-305: Apply PR feedback
Alxe Mar 8, 2024
d8c8782
Update product names
alexcamposruiz Mar 8, 2024
fce3fe9
Update license info
alexcamposruiz Mar 8, 2024
572d331
update year
alexcamposruiz Mar 8, 2024
6b88e3f
fix month
alexcamposruiz Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ The dependency [ref](https://www.npmjs.com/package/ref) is shipped as source cod

## License

RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
RTI Connector for JavaScript is part of the Connext
DDS Professional Package. If you have a valid license for the RTI Connext DDS
alexcamposruiz marked this conversation as resolved.
Show resolved Hide resolved
Professional Package, such license shall govern your use of RTI Connector for
Python and RTI Connector for JavaScript. All other use of this software shall
Professional Package, such license shall govern your use of
RTI Connector for JavaScript. All other use of this software shall
be governed solely by the terms of RTI’s Software License for Non-Commercial
Use #4040, included at the top level of the `Connector for Python repository
Use #4040.
7 changes: 3 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,9 @@ source code and requires a C++11 compiler.
License
-------

RTI Connector for JavaScript and RTI Connector for Python are part of
RTI Connector for JavaScript is part of
the Connext DDS Professional Package. If you have a valid license for
alexcamposruiz marked this conversation as resolved.
Show resolved Hide resolved
the RTI Connext DDS Professional Package, such license shall govern your
alexcamposruiz marked this conversation as resolved.
Show resolved Hide resolved
use of RTI Connector for Python and RTI Connector for JavaScript. All
use of RTI Connector for JavaScript. All
other use of this software shall be governed solely by the terms of
RTI’s Software License for Non-Commercial Use #4040, included at the top
level of the \`Connector for Python repository
RTI’s Software License for Non-Commercial Use #4040.
2 changes: 1 addition & 1 deletion docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ how they are exposed in the *Connector* API:

.. hint::

For an example configuration file, see `ShapeExample.xml <https://github.com/rticommunity/rticonnextdds-connector-py/blob/master/examples/python/ShapeExample.xml>`__.
For an example configuration file, see `ShapeExample.xml <https://github.com/rticommunity/rticonnextdds-connector-js/blob/master/examples/nodejs/ShapeExample.xml>`__.

Data types
~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions docs/copyright_license.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ February 2022. |br|

.. rubric:: License

RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
RTI Connector for JavaScript is part of the Connext
DDS Professional Package. If you have a valid license for the RTI Connext DDS
alexcamposruiz marked this conversation as resolved.
Show resolved Hide resolved
Professional Package, such license shall govern your use of RTI Connector for
Python and RTI Connector for JavaScript. All other use of this software shall
Professional Package, such license shall govern your use of
RTI Connector for JavaScript. All other use of this software shall
be governed solely by the terms of RTI’s Software License for Non-Commercial
Use #4040, included at the top level of the `Connector for JavaScript repository
<https://github.com/rticommunity/rticonnextdds-connector-js>`__.
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ data distribution efficient and robust. At its core is the world's
leading ultra-high performance, distributed networking databus.

*RTI Connector* is a family of simplified APIs for publishing and subscribing
to the *Connext DDS* Databus in programming languages such as Python and JavaScript.
to the *Connext DDS* Databus in programming languages such as JavaScript.
alexcamposruiz marked this conversation as resolved.
Show resolved Hide resolved

.. note::

Expand Down
7 changes: 3 additions & 4 deletions docs/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@ macOS® platforms. It has been tested on the following systems:

**Linux**
* CentOS™ 7.0 (x64)
* Red Hat® Enterprise Linux 7, 7.3, 7.5, 7.6, 8 (x64)
* Ubuntu® 18.04 (x64, Arm v7, Arm v8)
* Ubuntu 20.04, 22.04 LTS (x64)
* Red Hat® Enterprise Linux 7, 7.3, 7.5, 7.6, 8, 9 (x64)
* Ubuntu® 18.04 LTS (x64, Arm v7, Arm v8), 20.04 LTS (x64), 22.04 LTS (x64, Arm v8)

**macOS**
* macOS 11, 12, 13 (x64)

**Windows**
* Windows 10, 11 (x64)
* Windows Server 2016 (x64)
Alxe marked this conversation as resolved.
Show resolved Hide resolved
* Windows Server 2016, 2022 (x64)

*Connector* is supported in other languages in addition to JavaScript, see
`the main Connector
Expand Down