Skip to content

Commit f59ff8c

Browse files
authored
Adding required tags to page template. (#804)
* 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.
1 parent 7e2c0ec commit f59ff8c

File tree

3 files changed

+37
-17
lines changed

3 files changed

+37
-17
lines changed

docgen/content-sources/toc.yaml

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,20 @@ toc:
2323
- title: 'config.Config'
2424
path: /docs/reference/functions/config_.config.config.html
2525

26+
- title: 'functions.function-configuration'
27+
path: /docs/reference/functions/function_configuration_.html
28+
section:
29+
- title: 'config.DeploymentOptions'
30+
path: /docs/reference/functions/function_configuration_.deploymentoptions.html
31+
- title: 'config.FailurePolicy'
32+
path: /docs/reference/functions/function_configuration_.failurepolicy.html
33+
- title: 'config.RuntimeOptions'
34+
path: /docs/reference/functions/function_configuration_.runtimeoptions.html
35+
- title: 'config.Schedule'
36+
path: /docs/reference/functions/function_configuration_.schedule.html
37+
- title: 'config.ScheduleRetryConfig'
38+
path: /docs/reference/functions/function_configuration_.scheduleretryconfig.html
39+
2640
- title: 'functions.analytics'
2741
path: /docs/reference/functions/providers_analytics_.html
2842
section:
@@ -127,11 +141,6 @@ toc:
127141
- title: 'ObjectMetadata'
128142
path: /docs/reference/functions/providers_storage_.objectmetadata.html
129143

130-
- title: 'functions.handler'
131-
path: /docs/reference/functions/handler_builder_.html
132-
section:
133-
- title: 'HandlerBuilder'
134-
path: /docs/reference/functions/handler_builder_.handlerbuilder.html
135144
- title: 'functions.testLab'
136145
path: /docs/reference/functions/providers_testlab_.html
137146
section:
@@ -143,3 +152,9 @@ toc:
143152
path: /docs/reference/functions/providers_testlab_.testmatrix.html
144153
- title: 'testLab.testMatrixBuilder'
145154
path: /docs/reference/functions/providers_testlab_.testmatrixbuilder.html
155+
156+
- title: 'functions.handler'
157+
path: /docs/reference/functions/handler_builder_.html
158+
section:
159+
- title: 'HandlerBuilder'
160+
path: /docs/reference/functions/handler_builder_.handlerbuilder.html

docgen/theme/layouts/default.hbs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
<meta name="project_path" value="/_project.yaml" />
88
<meta name="book_path" value="/docs/reference/_book.yaml" />
99
<meta name="gtm_var" data-key="docType" data-value="reference">
10+
<meta name="page_type" value="reference" />
11+
<meta name="translation" value="disabled" />
1012
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
1113
<meta name="description" content="Reference for {{model.name}}">
1214
<meta name="viewport" content="width=device-width, initial-scale=1">

src/function-builder.ts

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -133,15 +133,15 @@ export function region(
133133
/**
134134
* Configure runtime options for the function.
135135
* @param runtimeOptions Object with optional fields:
136-
* 1. memory: amount of memory to allocate to the function, possible values
136+
* 1. `memory`: amount of memory to allocate to the function, possible values
137137
* are: '128MB', '256MB', '512MB', '1GB', and '2GB'.
138-
* 2. timeoutSeconds: timeout for the function in seconds, possible values are
138+
* 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
139139
* 0 to 540.
140-
* 3. failurePolicy: failure policy of the function, with boolean `true` being
140+
* 3. `failurePolicy`: failure policy of the function, with boolean `true` being
141141
* equivalent to providing an empty retry object.
142-
* 4. vpcConnector: id of a VPC connector in same project and region
143-
* 5. vpcConnectorEgressSettings: when a vpcConnector is set, control which
144-
* egress traffic is sent through the vpcConnector.
142+
* 4. `vpcConnector`: id of a VPC connector in the same project and region
143+
* 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which
144+
* egress traffic is sent through the `vpcConnector`.
145145
*
146146
* Value must not be null.
147147
*/
@@ -173,13 +173,16 @@ export class FunctionBuilder {
173173

174174
/**
175175
* Configure runtime options for the function.
176-
* @param runtimeOptions Object with three optional fields:
177-
* 1. failurePolicy: failure policy of the function, with boolean `true` being
176+
* @param runtimeOptions Object with optional fields:
177+
* 1. `memory`: amount of memory to allocate to the function, possible values
178+
* are: '128MB', '256MB', '512MB', '1GB', and '2GB'.
179+
* 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
180+
* 0 to 540.
181+
* 3. `failurePolicy`: failure policy of the function, with boolean `true` being
178182
* equivalent to providing an empty retry object.
179-
* 2. memory: amount of memory to allocate to the function, with possible
180-
* values being '128MB', '256MB', '512MB', '1GB', and '2GB'.
181-
* 3. timeoutSeconds: timeout for the function in seconds, with possible
182-
* values being 0 to 540.
183+
* 4. `vpcConnector`: id of a VPC connector in the same project and region
184+
* 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which
185+
* egress traffic is sent through the `vpcConnector`.
183186
*
184187
* Value must not be null.
185188
*/

0 commit comments

Comments
 (0)