Skip to content

Commit 7f4db13

Browse files
authored
Changes for first staged draft of EAP reference (#939)
* Adding required tags to page template. * Adding formatting and fixing typo discovered in internal review. * More fixes/additions discovered in internal review. * Fixing format of toc.yaml file. * Adding EAP TOC and index top matter. * Refine TOC, fix paths in template, attempt to hide params. * Doing all possible to make this YAML valid. VSCode extensions believe that it is.
1 parent e6eb1ea commit 7f4db13

File tree

5 files changed

+28
-24
lines changed

5 files changed

+28
-24
lines changed

docgen/content-sources/v2/HOME.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Firebase Functions v2 SDK Reference
22

3-
The `firebase-functions` package provides an SDK for defining Cloud Functions for Firebase.
3+
This package provides an SDK for defining Cloud Functions for Firebase v2.
44

5-
To get started using Cloud Functions, see
6-
[Get started: write, test, and deploy your first functions](/docs/functions/get-started).
5+
To get started using Cloud Functions v2, see
6+
the early access guide you were provided when you joined the EAP program.
77

8-
For source code, see the [Cloud Functions for Firebase GitHub repo](https://github.com/firebase/firebase-functions).
8+
**Important:** This API reference is confidential. Do not share or discuss until authorized to do so.

docgen/content-sources/v2/toc.yaml

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,36 @@
11
toc:
2-
- title: functions
3-
path: /docs/functions/alpha/v2.html
4-
- title: functions.core
2+
- title: 'functions'
3+
path: /docs/functions/alpha/index.html
4+
- title: 'functions.core'
55
path: /docs/functions/alpha/v2_core.html
66
section:
7-
- title: functions.CloudEvent
8-
path: /docs/functions/alpha/v2_core.cloudevent.html
9-
- title: functions.CloudFunction
10-
path: /docs/functions/alpha/v2_core.cloudfunction.html
11-
- title: functions.https
7+
- title: 'Functions v2'
8+
path: /docs/functions/alpha/v2.html
9+
- title: 'functions.CloudEvent'
10+
path: /docs/functions/alpha/v2_core.CloudEvent.html
11+
- title: 'functions.CloudFunction'
12+
path: /docs/functions/alpha/v2_core.CloudFunction.html
13+
- title: 'functions.https'
1214
path: /docs/functions/alpha/v2_providers_https.html
1315
section:
14-
- title: functions.https.options
15-
path: /docs/functions/alpha/v2_providers_https.httpsoptions.html
16+
- title: 'functions.https.CallableFunction'
17+
path: /docs/functions/alpha/v2_providers_https.CallableFunction.html
18+
- title: 'functions.https.options'
19+
path: /docs/functions/alpha/v2_providers_https.HttpsOptions.html
1620
- title: 'functions.logger'
1721
path: /docs/functions/alpha/logger.html
1822
section:
1923
- title: 'LogEntry'
2024
path: /docs/functions/alpha/logger.LogEntry.html
21-
- title: functions.options
25+
- title: 'functions.options'
2226
path: /docs/functions/alpha/v2_options.html
2327
section:
24-
- title: functions.options.GlobalOptions
25-
path: /docs/functions/alpha/v2_options.globaloptions.html
26-
- title: functions.options.EventHandlerOptions
27-
path: /docs/functions/alpha/v2_options.eventhandleroptions.html
28-
- title: functions.params
29-
path: /docs/functions/alpha/v2_params.html
28+
- title: 'functions.options.GlobalOptions'
29+
path: /docs/functions/alpha/v2_options.GlobalOptions.html
30+
- title: 'functions.options.EventHandlerOptions'
31+
path: /docs/functions/alpha/v2_options.EventHandlerOptions.html
3032
- title: 'functions.pubsub'
31-
path: /docs/functions/v2_providers_pubsub.html
33+
path: /docs/functions/alpha/v2_providers_pubsub.html
3234
section:
3335
- title: 'Message'
3436
path: /docs/functions/alpha/v2_providers_pubsub.Message.html

docgen/theme/layouts/default.hbs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="hide_page_heading" value="true" />
77
<meta name="project_path" value="/_project.yaml" />
8-
<meta name="book_path" value="/docs/reference/_book.yaml" />
9-
<meta name="gtm_var" data-key="docType" data-value="reference">
8+
<meta name="book_path" value="/docs/_book.yaml" />
9+
<meta name="gtm_var" data-key="docType" data-value="how-to">
1010
<meta name="page_type" value="reference" />
1111
<meta name="translation" value="disabled" />
1212
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>

src/v2/params/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @hidden */
12
import {
23
BooleanParam,
34
FloatParam,

src/v2/params/types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @hidden */
12
type ParamValueType = 'string' | 'list' | 'boolean' | 'int' | 'float' | 'json';
23

34
export interface ParamSpec<T = unknown> {

0 commit comments

Comments
 (0)