Skip to content

Commit 465ee97

Browse files
committed
address comments
1 parent bf0f78e commit 465ee97

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ App Hosting provides configuration-free build and deploy support for Web apps de
77
* Next.js 13+
88
* Angular 17.2+
99

10-
This repo holds the code for the adapters that enable support for these frameworks. At a high level these adapters transform frameowkr specific configurations into an output bundle spec that App Hosting is able to process and configure frameworks support. For more information see our [documentation](https://firebase.google.com/docs/app-hosting/about-app-hosting#frameworks)
10+
This repo holds the code for the adapters that enable support for these frameworks. At a high level these adapters transform framework specific configurations into an [output bundle spec](#app-hosting-output-bundle) that App Hosting is able to process and configure frameworks support. For more information see our [Framework integration](https://firebase.google.com/docs/app-hosting/about-app-hosting#frameworks).
1111

1212
## App Hosting output bundle
1313

@@ -29,7 +29,7 @@ The output bundle all lives inside a single file:
2929

3030
As long as this file exists and follows the schema App Hosting will be able to process the build properly.
3131

32-
The schema can also be found in <https://github.com/FirebaseExtended/firebase-framework-tools/blob/main/packages/%40apphosting/common/src/index.ts#L4>
32+
The schema can also be found in [source](https://github.com/FirebaseExtended/firebase-framework-tools/blob/main/packages/%40apphosting/common/src/index.ts#L4)
3333

3434
```typescript
3535
interface OutputBundle {
@@ -68,7 +68,7 @@ interface EnvVarConfig {
6868

6969
| Field | Type | Description |
7070
| ---------- | ------- | - |
71-
| runCommand | string |Command to start the server (e.g. "node dist/index.js"). Assume this command is run from the root dir of the workspace.This should be the productionized version of the server start command. |
71+
| runCommand | string |Command to start the server (e.g. "node dist/index.js"). Assume this command is run from the root dir of the workspace. This should be the productionized version of the server start command. |
7272
| environmentVariables| EnvVarConfig[] | Environment variables present in the server execution environment.|
7373
| concurrency | number | The maximum number of concurrent requests that each server instance can receive.|
7474
| cpu | number |The number of CPUs used in a single server instance. |
@@ -79,7 +79,7 @@ interface EnvVarConfig {
7979
| EnvVarConfig.value | string |Value associated with the environment variable |
8080
| EnvVarConfig.availability | RUNTIME | Where the variable will be available. For now this will always be RUNTIME |
8181

82-
Many of these fields are shared with apphosting.yaml as well so see [our documentation](https://firebase.google.com/docs/reference/apphosting/rest/v1beta/projects.locations.backends.builds#runconfig) for additional context.
82+
Many of these fields are shared with apphosting.yaml. See the [runConfig reference documentation](https://firebase.google.com/docs/reference/apphosting/rest/v1beta/projects.locations.backends.builds#runconfig) for additional context.
8383

8484
### Metadata
8585

@@ -100,7 +100,7 @@ interface Metadata {
100100
| framework | string | Name of the framework that is being supported|
101101
| frameworkVersion | string |Version of the framework that is being supported |
102102

103-
Putting this all together a sample bundle.yaml would look as follows:
103+
Here is a sample bundle.yaml file putting all this together:
104104

105105
```
106106
> cat .apphosting/bundle.yaml
@@ -128,4 +128,4 @@ metadata:
128128
129129
```
130130

131-
As long as you have the bundle.yaml in this format, App Hosting will be able to deploy any server side rendered framework.
131+
As long as you have the bundle.yaml in this format, App Hosting will be able to deploy any framework that supports server side rendering.

0 commit comments

Comments
 (0)