isabella232 / webrtc-org

WebRTC.org website (*** This repository is deprecated ***) - The documentation to contribute to native code is available at https://webrtc.googlesource.com/src/+/refs/heads/master/docs/native-code/index.md, info about WebRTC is available at https://webrtc.org)

The webrtc.org website

This is the repo for webrtc.org, home of the WebRTC project.

For more information about WebRTC, we maintain a list of WebRTC Resources. If you've never worked with WebRTC, we recommend you start with the 2013 Google I/O WebRTC presentation.

We welcome corrections, updates and additions!

See CONTRIBUTING for instructions. All contributors must sign a contributor license agreement before code can be accepted. Please complete the agreement for an individual or a corporation as appropriate.

Add or Edit Content

The webrtc.org site is built from Markdown files, using the Jekyll tool.

The default branch for the webrtc.org repo is gh-pages.

You can review your changes (after you've pushed them) on the GitHub Pages site for your fork. For example, if your username is foobar and you edited the Contributing Fixes page, you can view your updated version online at foobar.github.io/webrtc-org/contributing. A GitHub Pages site is automatically generated by GitHub for every repo that has a gh-pages branch.

You can also build and serve the site locally in order to check your work. See the instructions below.

Where are the Files?

Each page on the site corresponds to an index.md file in a directory of the repository's gh-pages branch. For example, the Development page at webrtc.org/native-code/development corresponds to github.com/webrtc/webrtc-org/tree/gh-pages/native-code/development/index.md.

To simplify URLs, many pages are at the top level of the site rather than in a subdirectory. For example, the Release Notes page is at webrtc.org/release-notes even though it lives under the site's About menu. (The corresponding Markdown file is github.com/webrtc/webrtc-org/tree/gh-pages/release-notes/index.md.)

Make a Correction or update

For minor content changes, fork the repo and make a pull request from your GitHub account.

For major or ongoing changes, create a branch and issue pull requests from that. Please delete the branch once you’ve finished working on it.

Find out more in our Developer's Guide.

Add a New Page

1. Create a new directory in your local repo, either at the top level of the site or in an existing directory.

2. Copy an existing index.md file into the new directory you created.

3. At the start of the new index.md file, adjust the YAML front matter that is used by the Jekyll build tool. For example, the following front matter will cause Jekyll to create a page with the title Android at webrtc.org/native-code/android/index.html:

   ---
   layout: default
   title: Android
   permalink: /native-code/android/
   ---
   

4. Edit the content of index.md: files are in Markdown format.

   Images are added with markup like the following example (from the Architecture page):

   ![]({{ site.baseurl }}/assets/images/webrtc-public-diagram-for-website.png)

   Add code snippets like this:

   ~~~~~ bash
   export JAVA_HOME=<location of OpenJDK 7>
   ~~~~~
   

5. Commit and push your work.

6. Review your changes locally or from the GitHub Pages site for your fork (for example, usename.github.io/webrtc-org).

7. Make a pull request.

Build and Serve the Site Locally

These steps are optional, and require familiarity with managing gem dependencies. If you're only interested is previewing changes before making a pull request, see Add or Edit Content, above.

1. If necessary, install Ruby.

2. Navigate to your webrtc-org repo directory.

3. Run the following command:

   bundle exec jekyll serve
   

   HTML files are generated in the _site directory and regenerated automatically when you make changes.

4. View the modified site in a browser at http://0.0.0.0:4000/webrtc-org.

More information is available from Using Jekyll With Pages (but do not run the Setting up Jekyll step!)