Skip to content

Commit

Permalink
Edit headings of the codelabs, contributors, and development cobalt/s…
Browse files Browse the repository at this point in the history
…ite/docs files for DevSite migration (youtube#1855)

Edited the headings of codelabs, contributors, and development
cobalt/site/docs so that they're compatible with DevSite. Also removed
the main index file and fixed typos.

b/236404667
  • Loading branch information
alexanderahn authored Nov 1, 2023
2 parents 4146183 + f15eec0 commit 72a37d5
Show file tree
Hide file tree
Showing 45 changed files with 144 additions and 199 deletions.
8 changes: 4 additions & 4 deletions cobalt/site/docs/codelabs/starboard_extensions/codelab.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Starboard Extensions codelab"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Starboard Extensions codelab

The Starboard Extension framework provides a way to add optional, platform-specific
features to the Starboard application. A Starboard Extension is an optional interface
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/contributors/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Contributing to Cobalt"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Contributing to Cobalt

We'd love to hear about how you would like to contribute to Cobalt!

Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/reference/supported-features.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Cobalt Support Quick Reference"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Support Quick Reference

## HTML elements

Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/setup-android.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Set up your environment - Android"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Set up your environment - Android

These instructions explain how to set up Cobalt for your workstation and Android
device. The package being built here is referred to as CoAT (Cobalt on Android TV).
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/setup-docker.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Set up your environment - Docker"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Set up your environment - Docker

We provide <a
href="https://github.com/youtube/cobalt/tree/main/docker/linux/">Docker image definitions</a> to simplify managing build environments.
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/setup-linux.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Set up your environment - Linux"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Set up your environment - Linux

These instructions explain how Linux users set up their Cobalt development
environment, clone a copy of the Cobalt code repository, and build a Cobalt
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/setup-raspi.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Set up your environment - Raspberry Pi"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Set up your environment - Raspberry Pi

These instructions explain how to set up Cobalt for your workstation and your
Raspberry Pi device. They have been tested with Ubuntu:20.04 and a Raspberry Pi
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/setup-rdk.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Set up your environment - RDK"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Set up your environment - RDK

The detailed documentation for building and using RDK-V reference port is
provided by the RDK project. Please see details in
Expand Down
8 changes: 4 additions & 4 deletions cobalt/site/docs/development/setup-windows.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: doc
title: "Set up your environment - Windows"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Set up your environment - Windows

These instructions explain how Windows users can set up their Cobalt development
environment, clone a copy of the Cobalt code repository, and build a Cobalt
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/branching.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Branching"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Branching

*(This document assumes you are already familiar
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/clients_performance_guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Clients Performance Guide"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Clients Performance Guide

This document contains a list of hints and tricks for using web technologies
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/cvals.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt CVals"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt CVals

## Overview
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/deep_links.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Deep Links"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Deep Links

- [Cobalt Deep Links](#cobalt-deep-links)
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/device_authentication.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Device Authentication"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Device Authentication

Starting in Cobalt 20, initial URL requests will now have query parameters
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/docker_build.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Docker builds"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Docker builds

Cobalt includes [Docker image][docker.com](https://www.docker.com/)
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Application Lifecycle"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Application Lifecycle

In order to meet common needs of applications running on CE devices, Cobalt
Expand Down
9 changes: 4 additions & 5 deletions cobalt/site/docs/gen/cobalt/doc/memory_tuning.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
layout: doc
title: ""
---
# Memory Tuning #
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Memory Tuning

Cobalt is designed to choose sensible parameters for memory-related options and
parameters through a system called "AutoMem".
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/net_log.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt NetLog"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt NetLog

Chromium has a very useful network diagnostic tool called the NetLog and Cobalt
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/performance_tuning.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Performance Tuning"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Performance Tuning

Cobalt is designed to choose sensible parameters for all performance-related
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/platform_services.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Platform Services"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Platform Services

_NOTE: The Cobalt Platform Services API replaces the deprecated Cobalt Custom Web API Extensions_
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/spherical_video.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Enabling Spherical Video in Cobalt"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Enabling Spherical Video in Cobalt

Cobalt supports playback of 360 spherical videos. Cobalt does not expose
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/splash_screen.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Splash Screen"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Splash Screen

## Startup splash screen sequence
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/versioning.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Versioning"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Versioning

Cobalt versions, as they appear in the user agent, have the following structure:
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/voice_search.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Enabling voice search in Cobalt"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Enabling voice search in Cobalt

Cobalt enables voice search through a subset of the
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/cobalt/doc/web_debugging.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Cobalt Web Debugging"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Cobalt Web Debugging

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Stub to Platform GN Migration"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Stub to Platform GN Migration

This document outlines a step by step process for converting the stub platform's
Expand Down
10 changes: 4 additions & 6 deletions cobalt/site/docs/gen/starboard/build/doc/migrating_gyp_to_gn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Migrating GYP to GN"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Migrating GYP to GN

Cobalt is currently in the process of migrating from our current build system
Expand Down Expand Up @@ -205,8 +204,7 @@ them.
### Validating a Target

If you're migrating a single target, it's simple to check: just configure the
build using the the necessary arguments then build that target with `ninja`,
i.e.:
build using the necessary arguments then build that target with `ninja`, i.e.:

```
static_library("new_target") { ... }
Expand Down
9 changes: 4 additions & 5 deletions cobalt/site/docs/gen/starboard/build/doc/migration_changes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "GYP to GN Migration Changes"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# GYP to GN Migration Changes

This file tracks changes to configuration meta build configuration variables in
Expand Down Expand Up @@ -46,7 +45,7 @@ variables.
## Notes:

* *Starboard Implementation:* If your platform defined
`STARBOARD_IMPLENTATION` in its implementation, you would now add the above
`STARBOARD_IMPLEMENTATION` in its implementation, you would now add the above
config with `configs +=
["//starboard/build/config:starboard_implementation"]`.

Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/starboard/doc/api_process.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Starboard API Review Process"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Starboard API Review Process

## Why do we need a process?
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/starboard/doc/building.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Building Starboard"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Building Starboard

Starboard currently uses GYP as the basis of its build system, though there is
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/starboard/doc/c99.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Starboard and C99"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Starboard and C99

## Background
Expand Down
7 changes: 3 additions & 4 deletions cobalt/site/docs/gen/starboard/doc/crash_handlers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: doc
title: "Installing Crash Handlers in Cobalt"
---
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Installing Crash Handlers in Cobalt

Partners can install Crashpad's crash handlers to create crash reports in the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
layout: doc
title: "Evergreen Lite Partner Doc"
---
Evergreen Lite Partner Doc
Project: /youtube/cobalt/_project.yaml
Book: /youtube/cobalt/_book.yaml

# Evergreen Lite Partner Doc

## What is Cobalt Evergreen Lite?

Expand Down
Loading

0 comments on commit 72a37d5

Please sign in to comment.