Reland "Migrate WebRTC documentation to new renderer"

This reverts commit 0f2ce5cc1c.

Reason for revert: Downstream infrastructure should be ready now

Original change's description:
> 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}

Bug: b/258408932
Change-Id: Ia172e4a6ad1cc7953b48eed08776e9d1e44eb074
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/291660
Owners-Override: Artem Titov <titovartem@webrtc.org>
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Bot-Commit: rubber-stamper@appspot.gserviceaccount.com <rubber-stamper@appspot.gserviceaccount.com>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#39231}
This commit is contained in:
Artem Titov 2023-01-30 10:51:01 +00:00 committed by WebRTC LUCI CQ
parent 23671039b0
commit a617867a45
40 changed files with 105 additions and 121 deletions

View file

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

View file

@ -1,6 +1,9 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'hta' reviewed: '2021-01-01'} *-->
# How to write code in the `api/` directory # 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 * 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 pairs” rule, so if you declare something in `api/path/to/foo.h`, it should be
@ -17,7 +20,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 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 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 `.cc` files in `api/` should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public substantial implementation is needed, consider putting it with our non-public

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -2,9 +2,14 @@
* How to contribute * How to contribute
* Code * Code
* [Style guide](/g3doc/style-guide.md) * [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) * [Documentation](/g3doc/how_to_write_documentation.md)
* [Become a committer](/g3doc/become_a_committer.md) * [Become a committer](/g3doc/become_a_committer.md)
* [Public C++ API](/api/g3doc/index.md) * [Public C++ API](/api/g3doc/index.md)
* [API header files](/native-api.md)
* [Threading](/api/g3doc/threading_design.md) * [Threading](/api/g3doc/threading_design.md)
* Implementation * Implementation
* [Basic concepts](/g3doc/implementation_basics.md) * [Basic concepts](/g3doc/implementation_basics.md)

View file

@ -1,7 +1,7 @@
# WebRTC coding style guide <!-- go/cmark -->
<!--* freshness: {owner: 'danilchap' reviewed: '2022-01-17'} *-->
<?% config.freshness.owner = 'danilchap' %?> # WebRTC coding style guide
<?% config.freshness.reviewed = '2022-01-17' %?>
## General advice ## General advice

View file

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

View file

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

View file

@ -1,7 +1,7 @@
# RTC event log <!-- go/cmark -->
<!--* freshness: {owner: 'terelius' reviewed: '2021-06-02'} *-->
<?% config.freshness.owner = 'terelius' %?> # RTC event log
<?% config.freshness.reviewed = '2021-06-02' %?>
## Overview ## Overview

View file

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

View file

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

View file

@ -1,7 +1,7 @@
# Audio Device Module (ADM) <!-- go/cmark -->
<!--* freshness: {owner: 'henrika' reviewed: '2021-04-12'} *-->
<?% config.freshness.owner = 'henrika' %?> # Audio Device Module (ADM)
<?% config.freshness.reviewed = '2021-04-12' %?>
## Overview ## Overview

View file

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

View file

@ -1,7 +1,7 @@
# Audio Processing Module (APM) <!-- go/cmark -->
<!--* freshness: {owner: 'peah' reviewed: '2021-04-13'} *-->
<?% config.freshness.owner = 'peah' %?> # Audio Processing Module (APM)
<?% config.freshness.reviewed = '2021-04-13' %?>
## Overview ## Overview

View file

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

View file

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

View file

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

View file

@ -1,7 +1,7 @@
# ICE <!-- go/cmark -->
<!--* freshness: {owner: 'jonaso' reviewed: '2021-04-12'} *-->
<?% config.freshness.owner = 'jonaso' %?> # ICE
<?% config.freshness.reviewed = '2021-04-12' %?>
## Overview ## Overview

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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