Revert "Migrate WebRTC documentation to new renderer"

This reverts commit 3eceaf4669.

Reason for revert: 

Original change's description:
> Migrate WebRTC documentation to new renderer
>
> Bug: b/258408932
> Change-Id: Ib96f39fe0c3912f9746bcc09d079097a145d6115
> Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/290987
> Reviewed-by: Harald Alvestrand <hta@webrtc.org>
> Commit-Queue: Artem Titov <titovartem@webrtc.org>
> Cr-Commit-Position: refs/heads/main@{#39205}

Bug: b/258408932
Change-Id: I16cb4088bee3fc15c2bb88bd692c592b3a7db9fe
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/291560
Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com>
Owners-Override: Artem Titov <titovartem@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#39209}
This commit is contained in:
Artem Titov 2023-01-26 20:18:46 +00:00 committed by WebRTC LUCI CQ
parent b0d8a3728c
commit 0f2ce5cc1c
40 changed files with 121 additions and 105 deletions

View file

@ -1,6 +1,3 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-01-01'} *-->
# Contributors Code of Conduct
Google and the WebRTC team are committed to preserving and fostering a diverse, welcoming and open

View file

@ -1,9 +1,6 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-01-01'} *-->
# How to write code in the `api/` directory
Mostly, just follow the regular [style guide](/g3doc/style-guide.md), but:
Mostly, just follow the regular [style guide](../g3doc/style-guide.md), but:
* Note that `api/` code is not exempt from the “`.h` and `.cc` files come in
pairs” rule, so if you declare something in `api/path/to/foo.h`, it should be
@ -20,7 +17,7 @@ it from a `.cc` file, so that users of our API headers wont transitively
For headers in `api/` that need to refer to non-public types, forward
declarations are often a lesser evil than including non-public header files. The
usual [rules](/g3doc/style-guide.md#forward-declarations) still apply, though.
usual [rules](../g3doc/style-guide.md#forward-declarations) still apply, though.
`.cc` files in `api/` should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-04-12'} *-->
<?% config.freshness.owner = 'hta' %?>
<?% config.freshness.reviewed = '2021-04-12' %?>
# The WebRTC API

View file

@ -1,6 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-04-12'} *-->
<?% config.freshness.owner = 'hta' %?>
<?% config.freshness.reviewed = '2021-04-12' %?>
# API Threading Design considerations
The header files in this directory form the API to the WebRTC library

1
g3doc.lua Normal file
View file

@ -0,0 +1 @@
return require(this.dirname..'g3doc/g3doc.lua')

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'danilchap' reviewed: '2021-05-12'} *-->
# Using Abseil in WebRTC
<?% config.freshness.owner = 'danilchap' %?>
<?% config.freshness.reviewed = '2021-05-12' %?>
You may use a subset of the utilities provided by the [Abseil][abseil]
library when writing WebRTC C++ code. Below, we list the explicitly
*allowed* and the explicitly *disallowed* subsets of Abseil; if you

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2021-10-26'} *-->
# How to get tryjob access or become WebRTC committer
<?% config.freshness.owner = 'titovartem' %?>
<?% config.freshness.reviewed = '2021-10-26' %?>
## Overview
There are two levels of WebRTC contributors access:

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'lndmrk' reviewed: '2022-06-23'} *-->
# Field trials
<?% config.freshness.owner = 'lndmrk' %?>
<?% config.freshness.reviewed = '2022-06-23' %?>
WebRTC provides some means to alter its default behavior during run-time,
colloquially known as *field trials*. This is foremost used for A/B testing new
features and are related to

20
g3doc/g3doc.lua Normal file
View file

@ -0,0 +1,20 @@
return {
theme = {
'@builtins/theme/ng.md',
-- We don't want to have more than h3 headings in the Table Of Content.
toc_level = 3,
},
site = {
name = 'WebRTC C++ library',
home = this.dirname..'index.md',
logo = this.dirname..'logo.svg',
map = this.dirname..'sitemap.md',
-- Ensure absolute links are rewritten correctly.
root = this.dirname..'..'
},
visibility = { '/...' },
freshness = {}
}

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2023-01-16'} *-->
# How to write WebRTC documentation
<?% config.freshness.owner = 'titovartem' %?>
<?% config.freshness.reviewed = '2021-03-01' %?>
## Audience
Engineers and tech writers who wants to contribute to WebRTC documentation
@ -15,7 +15,7 @@ documentation can skip some edge cases in favor of clarity. The main point
is to impart understanding.
Conceptual documentation often cannot be embedded directly within the source
code because it usually describes multiple APIs and entities, so the only
code because it usually describes multiple APIs and entites, so the only
logical place to document such complex behavior is through a separate
conceptual document.
@ -28,14 +28,7 @@ usage and leave rare ones or side effects for class/function level comments.
In the WebRTC repo, conceptual documentation is located in `g3doc` subfolders
of related components. To add a new document for the component `Foo` find a
`g3doc` subfolder for this component and create a `.md` file there with
desired documentation. If there is no `g3doc` subfolder, create a new one.
Please put the following file header into any created documentation file as the
first line:
```markdown
<!-- go/cmark -->
```
desired documentation. If there is no `g3doc` subfolder, create a new one;
When you want to specify a link from one page to another - use the absolute
path:
@ -49,7 +42,17 @@ keeping this documentation updated, by adding the next lines at the beginning
of your `.md` file immediately after page title:
```markdown
<!--* freshness: {owner: '<user name>' reviewed: '<last review date in format yyyy-mm-dd>' *-->
<?\% config.freshness.owner = '<user name>' %?>
<?\% config.freshness.reviewed = '<last review date in format yyyy-mm-dd>' %?>
```
If you want to configure the owner for all pages under a directory, create a
`g3doc.lua` file in that directory with the content:
```lua
config = super()
config.freshness.owner = '<user name>'
return config
```
After the document is ready you should add it into `/g3doc/sitemap.md`, so it

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-05-31'} *-->
<?% config.freshness.owner = 'hta' %?>
<?% config.freshness.reviewed = '2021-05-31' %?>
# Basic concepts and primitives

View file

@ -1,6 +1,6 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2021-03-01'} *-->
# WebRTC C++ library
<?% config.freshness.owner = 'titovartem' %?>
<?% config.freshness.reviewed = '2021-03-01' %?>
This is a home page for WebRTC C++ library documentation

View file

@ -2,14 +2,9 @@
* How to contribute
* Code
* [Style guide](/g3doc/style-guide.md)
* [`.h` and `.cc` files come in pairs](g3doc/style-guide/h-cc-pairs.md)
* [How to write code in the `api/` directory](/api/README.md)
* [Using Abseil in WebRTC](/g3doc/abseil-in-webrtc.md)
* [Code of conduct](/CODE_OF_CONDUCT.md)
* [Documentation](/g3doc/how_to_write_documentation.md)
* [Become a committer](/g3doc/become_a_committer.md)
* [Public C++ API](/api/g3doc/index.md)
* [API header files](/native-api.md)
* [Threading](/api/g3doc/threading_design.md)
* Implementation
* [Basic concepts](/g3doc/implementation_basics.md)

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'danilchap' reviewed: '2022-01-17'} *-->
# WebRTC coding style guide
<?% config.freshness.owner = 'danilchap' %?>
<?% config.freshness.reviewed = '2022-01-17' %?>
## General advice
Some older parts of the code violate the style guide in various ways.

View file

@ -1,9 +1,9 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'danilchap' reviewed: '2021-05-12'} *-->
# `.h` and `.cc` files come in pairs
This is an overflow page for [this](/g3doc/style-guide.md#h-cc-pairs)
<?% config.freshness.owner = 'danilchap' %?>
<?% config.freshness.reviewed = '2021-05-12' %?>
This is an overflow page for [this](../style-guide.md#h-cc-pairs)
style rule.
## Example violations

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'mbonadei' reviewed: '2021-06-25'} *-->
# WebRTC supported plaftorms and compilers
<?% config.freshness.owner = 'mbonadei' %?>
<?% config.freshness.reviewed = '2021-06-25' %?>
## Operating systems and CPUs
The list of officially supported operating systems and CPUs is:

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'terelius' reviewed: '2021-06-02'} *-->
# RTC event log
<?% config.freshness.owner = 'terelius' %?>
<?% config.freshness.reviewed = '2021-06-02' %?>
## Overview
RTC event logs can be enabled to capture in-depth inpformation about sent and

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hlundin' reviewed: '2021-04-13'} *-->
<?% config.freshness.owner = 'minyue' %?>
<?% config.freshness.reviewed = '2021-04-13' %?>
# The WebRTC Audio Coding Module

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'jakobi' reviewed: '2021-04-13'} *-->
<?% config.freshness.reviewed = '2021-04-13' %?>
<?% config.freshness.owner = 'jakobi' %?>
# NetEq

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'henrika' reviewed: '2021-04-12'} *-->
# Audio Device Module (ADM)
<?% config.freshness.owner = 'henrika' %?>
<?% config.freshness.reviewed = '2021-04-12' %?>
## Overview
The ADM is responsible for driving input (microphone) and output (speaker) audio

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'alessiob' reviewed: '2021-04-21'} *-->
<?% config.freshness.owner = 'alessiob' %?>
<?% config.freshness.reviewed = '2021-04-21' %?>
# The WebRTC Audio Mixer Module

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'peah' reviewed: '2021-04-13'} *-->
# Audio Processing Module (APM)
<?% config.freshness.owner = 'peah' %?>
<?% config.freshness.reviewed = '2021-04-13' %?>
## Overview
The APM is responsible for applying speech enhancements effects to the

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'sprang' reviewed: '2021-04-12'} *-->
<?% config.freshness.reviewed = '2021-04-12' %?>
<?% config.freshness.owner = 'sprang' %?>
# Paced Sending

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'brandtr' reviewed: '2021-04-15'} *-->
<?% config.freshness.owner = 'brandtr' %?>
<?% config.freshness.reviewed = '2021-04-15' %?>
# Video coding in WebRTC

View file

@ -1,6 +1,3 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-01-01'} *-->
# API header files
As a user of the WebRTC library, you may use headers and build files

View file

@ -1,8 +1,8 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'jonaso' reviewed: '2021-04-12'} *-->
# ICE
<?% config.freshness.owner = 'jonaso' %?>
<?% config.freshness.reviewed = '2021-04-12' %?>
## Overview
ICE ([link](https://developer.mozilla.org/en-US/docs/Glossary/ICE)) provides

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-05-07'} *-->
<?% config.freshness.reviewed = '2021-05-07' %?>
<?% config.freshness.owner = 'hta' %?>
## Overview

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-05-07'} *-->
<?% config.freshness.reviewed = '2021-05-07' %?>
<?% config.freshness.owner = 'hta' %?>
# PeerConnection and friends

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-06-03'} *-->
<?% config.freshness.reviewed = '2021-06-03' %?>
<?% config.freshness.owner = 'hta' %?>
# RTP in WebRTC

View file

@ -1,5 +1,6 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-04-13'} *-->
<?% config.freshness.reviewed = '2021-04-13' %?>
<?% config.freshness.owner = 'hta' %?>
# SctpTransport

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-05-13'} *-->
<?% config.freshness.reviewed = '2021-05-13' %?>
<?% config.freshness.owner = 'hta' %?>
# SRTP in WebRTC

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2022-10-01'} *-->
<?% config.freshness.reviewed = '2022-10-01' %?>
<?% config.freshness.owner = 'hta' %?>
# getStats in WebRTC

View file

@ -0,0 +1,5 @@
config = super()
config.freshness.owner = 'titovartem'
return config

View file

@ -1,8 +1,7 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2021-03-01'} *-->
# Network Emulation Framework
<?% config.freshness.reviewed = '2021-03-01' %?>
[TOC]
## Disclamer

View file

@ -1,5 +1,4 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2021-04-12'} *-->
<?% config.freshness.reviewed = '2021-04-12' %?>
# PeerConnection level framework fixture architecture

View file

@ -1,5 +1,4 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2021-02-21'} *-->
<?% config.freshness.reviewed = '2021-02-21' %?>
# DefaultVideoQualityAnalyzer

View file

@ -0,0 +1,5 @@
config = super()
config.freshness.owner = 'titovartem'
return config

View file

@ -1,5 +1,4 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'titovartem' reviewed: '2021-04-12'} *-->
<?% config.freshness.reviewed = '2021-04-12' %?>
# PeerConnection Level Framework

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'eshr' reviewed: '2021-04-13'} *-->
<?% config.freshness.reviewed = '2021-04-13' %?>
<?% config.freshness.owner = 'eshr' %?>
# Video Adaptation

View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'asapersson' reviewed: '2021-04-14'} *-->
<?% config.freshness.reviewed = '2021-04-14' %?>
<?% config.freshness.owner = 'asapersson' %?>
# Video stats