https://github.com/ringcentral/ringcentral-api-docs
Official RingCentral Connect Platform Developer Guide
https://github.com/ringcentral/ringcentral-api-docs
documentation
Last synced: about 1 year ago
JSON representation
Official RingCentral Connect Platform Developer Guide
- Host: GitHub
- URL: https://github.com/ringcentral/ringcentral-api-docs
- Owner: ringcentral
- Created: 2016-07-25T17:42:09.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T20:41:45.000Z (about 1 year ago)
- Last Synced: 2025-03-29T10:08:21.110Z (about 1 year ago)
- Topics: documentation
- Language: Python
- Homepage: https://developers.ringcentral.com/guide/
- Size: 47.1 MB
- Stars: 38
- Watchers: 16
- Forks: 70
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# RingCentral Developer Guide Documentation
This repository is the home of the RingCentral Developer Guide: a collection of materials, and documentation to help educate developers on how to build on top of the RingCentral platform.
This repository powers the production of two key resources:
1. [RingCentral Developer Guide](https://ringcentral-api-docs.readthedocs.io/en/latest/oauth/)
2. [RingCentral Tutorials Index](https://ringcentral.github.io/tutorials/)
## Inside this Repository
RingCentral's [Developer Guide](https://ringcentral-api-docs.readthedocs.io/en/latest/) is powered by [Read the Docs](https://readthedocs.org/), and makes up the bulk of this repository. To contribute to this documentation effort, start by looking at `mydocs.yml` which powers the generation of the table of contents and points to the specific documents located within the `docs` directory.
RingCentral's [Tutorials](https://ringcentral.github.io/tutorials/) index aggregates content found here, as well as content across the web. It is powered by `tutorials.json`.
## Contributing
If you would like to contribute to the RingCentral documentation effort, fork this repository, make your desired edits and contributions, and issue a pull request accordingly.
### Running the Developer Guide locally
The Developer Guide is built on top of Mkdocs, a self-contained documentation server. Writers are encouraged to install Mkdocs locally so that you can edit files and preview your changes before they are pushed to production servers.
```shell
git clone https://github.com/ringcentral/ringcentral-api-docs.git
cd ringcentral-api-docs
pip install mkdocs
pip install -r requirements.txt
mkdocs serve
```
Then you should be able to load to view the documentation.
Please be aware that the local version of the Developer Guide utilizes a Mkdocs theme that *mimics* our main documentation site, but it is not the same -- hence some of the visual differences you may observe. When the Developer Guide is published officially, mkdocs is used to generate HTML files, and those HTML files are then loaded into a different presentation framework.
## How to test and verify code samples
First, let's setup our python virtual environment within which the code checking framework will be run. We will do this from the root directory of `ringcentral-api-docs`. Then we will install the code checking framework within that virtual environment.
```shell
cd $GITHUB/ringcentral-api-docs
python3 -m venv .
source ./bin/activate
python3 -m pip install --upgrade pip
pip3 install mkdocs-codecheck
```
The code checking framework can be installed via pip ([mkdocs-codecheck](https://pypi.org/project/mkdocs-codecheck)), or the bleeding edge version can be downloaded and installed from [github](https://github.com/byrnereese/codechecker-mkdocs).
Next, you need to install all the various libraries and other prerequisites used within the code samples for all of the languages we support.
**For python code samples**
```shell
pip install ringcentral
pip install python-dotenv
```
**For PHP code samples**
```shell
php composer.phar require ringcentral/ringcentral-php
```
**For Java code samples**
To test java code samples, you will need to make sure you have Java installed, and your CLASSPATH has been setup properly to point to the following jar files.
* RingCentral Java SDK
* Jetty Util, Server and Servlet
* J2EE
* Gson
* FastJSON
STEPS to compile and run Java Sample Code using Maven (make sure maven build tool)
```shell
git clone
cd ringcentral-api-docs/code-samples/java-samples
mvn clean compile
```
TODO (internal):
1. Adjust mkdocs script for Java so it no longer relies on CLASSPATH environment variable, instead uses maven to compile, run, test Java sample code.
2. Add JUnit Tests
### For DotNet and .cs code samples
Mac and Linux users can install the `dotnet-sdk` package via brew:
```shell
brew install --cask dotnet-sdk
```
Then you will need to install the RingCentral SDK, globally:
```shell
dotnet tool install --global RingCentral.Net
```
### Create a .env file
Create a `.env` file in the `code-samples` directory by copying and editing the provided template. This file will make reference to an app for which all permissions have been enabled. Embed that app's credentials in your `.env` in the appropriate fields.
```shell
cp code-samples/env-template code-samples/.env
```
### Run the testing framework
With all necessary software installed, you can now run the script. Run the script from the root directory of `ringcentral-api-docs` and be sure your python virtual environment is activated.
```shell
cd $GITHUB/ringcentral-api-docs
sh ./bin/activate
mkdocs-codecheck --verbose --recurse --dotenv ./code-samples/.env ./code-samples
```
## Tips for Styling Documentation
### View our styleguide
Our [styleguide](https://github.com/ringcentral/ringcentral-api-docs/blob/master/docs/styleguide.md) serves as a reference for the various documentation syntaxes to help writers format their documentation and utilize markdown to its fullest extent. The styleguide demonstrates the following styles:
* Fenced Code Blocks
* Admonitions, or call outs
* Tables
* Syntax highlighting and line highlighting
### Customizing the underlying theme and HTML
For local development, mkdocs uses a [RingCentral Mkdocs Theme](https://github.com/byrnereese/mkdocs-ringcentral). If you wish to affect the underlying structure of the site you have two choices:
* Override locally
* Fix globally
To override locally, consult the mkdocs documentation on creating a [custom theme](https://www.mkdocs.org/user-guide/custom-themes/). The process involves overriding theme files with your own custom files. This requires you understand the underlying theme structure, so consult the structure of [mkdocs-ringcentral](https://github.com/byrnereese/mkdocs-ringcentral).
To make a change globally, you can also submit a pull request to [mkdocs-ringcentral](https://github.com/byrnereese/mkdocs-ringcentral) and the change can be propagated across all documentation projects that utilize it.
### Utilizing components from Bootstrap
Our documentation is all based on the open-source CSS framework called Bootstrap. It makes available a number of commonly used UI components that can be cut and paste into our docs and be rendered faithfully.
* Visit the [Bootstrap Component Library](https://getbootstrap.com/docs/4.4/components/alerts/) to learn more
### Using the Material component library
Our documentation also makes use of the [Mkdocs Material Plugin](https://squidfunk.github.io/mkdocs-material/). This plugin is what renders admonitions for example.
```text
!!! note "Phasellus posuere in sem ut cursus"
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod.
```
This plugin extends the markdown language new ways of encoding text in markdown, including:
* [admonitions](https://squidfunk.github.io/mkdocs-material/extensions/admonition/)
* [footnotes/citations](https://squidfunk.github.io/mkdocs-material/extensions/footnotes/)
* [HTML meta tags](https://squidfunk.github.io/mkdocs-material/extensions/metadata/)
There are a number of [other Markdown extensions](https://squidfunk.github.io/mkdocs-material/extensions/pymdown/) available through Material as well.
### Embedding Code Samples in documentation
Inside of this repository is a `code-samples` directory, into which is placed all the code samples that can be found in our documentation. Each code sample stored here is a fully functional, stand-alone script that can be run directly by a developer.
Writers can then include content from a code sample using the following syntax:
```javascript
{! code-samples/path/to/code-sample.js [ln:35-48] !}
```
The above example includes the file referenced, but only lines 35 through 48. This makes it possible to only include fragments of a code sample, while maintaining the integrity of the code sample's ability to be run as a stand-alone script.
This include functionality is provided by the [mdx_include extension](https://github.com/neurobin/mdx_include). Consult its documentation to learn how to use it more effectively.