This repository contains the documentation for the RingCentral Integration Apps.
The site is build using Mkdocs and Mkdocs Material.
Make sure you have python3 installed.
Then install the dependencies. Assuming that you have not override the default python3 path, you can install the dependencies by running the following command.
pip3 install -r requirements.txtThen you can run the development server by running the following command.
mkdocs serveSee LOCAL-SETUP.md for detailed instructions if needed.
- Forking is not required. You can just clone the repository and start contributing.
- Please always create a new branch from the main branch and create merge-requests to the main branch.
See CONTRIBUTION.md for more details.
-
Make sure all the required MRs are merged.
-
On your local repo, switch back to the main branch:
git checkout main- Now we want to make sure that the local main is up to date:
git pull --rebase- You can check the commit logs to make sure:
git log-
Hit
Qto quit the commit log view. -
Now we're ready to publish.
-
First check the existing tags:
git tag-
The tags should be in the format
publish-yyyy-MON-dd. But the CI only checks forpublish-*. -
Add a new tag by using the following, just use the current date. Add additional dashes and numbers if publishing multiple times a day:
git tag publish-year-MON-dd- Lastly, push the new tag:
git push --tagsThat will trigger the CI in GitLab to sync the tagged version to GitHub, and then GitHub CI will publish to GitHub Pages.
- Start with a basic site structure
- Publish the site to github pages
- Enhance the gitlab repo to allow internal only contents
- Create public site preparation scripts to push public only content to github
- Work with CFI team to create a process to allow internal contents to be referenced
- Submit SEO results to RC main support site
- Create a process to build internal contents
- Create a process to build public contents