Skip to content

Commit f0f70ae

Browse files
committed
remove old readme
1 parent 9f35fec commit f0f70ae

File tree

2 files changed

+20
-155
lines changed

2 files changed

+20
-155
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The App Hosting output bundle is a file based specification that allows differen
1515

1616
Any framework that can generate a build output in accordance with the App Hosting output bundle can be deployed on App Hosting.
1717

18-
The output bundle primarily consists of a bundle.yaml file that sits inside of the .apphosting directory. This bundle.yaml contains all the ways that frameworks can configure App Hosting when users deploy their applications.
18+
The output bundle primarily consists of a `bundle.yaml` file that sits inside of the `.apphosting` directory. This bundle.yaml contains all the ways that frameworks can configure App Hosting when users deploy their applications.
1919

2020
NOTE: App Hosting technically supports all all node applications, but no custom framework features will be enabled without the output bundle.
2121

@@ -41,7 +41,7 @@ interface OutputBundle {
4141

4242
### Version
4343

44-
The version represents which output bundle version is currently being used. The current version is v1.
44+
The `version` represents which output bundle version is currently being used. The current version is v1.
4545

4646
### RunConfig
4747

@@ -68,18 +68,18 @@ 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. |
72-
| environmentVariables| EnvVarConfig[] | Environment variables present in the server execution environment.|
73-
| concurrency | number | The maximum number of concurrent requests that each server instance can receive.|
74-
| cpu | number |The number of CPUs used in a single server instance. |
75-
| memoryMiB | number | The amount of memory available for a server instance.|
76-
| minInstance | number |The limit on the minimum number of function instances that may coexist at a given time. |
77-
| MaxInstance | number | The limit on the maximum number of function instances that may coexist at a given time.|
78-
| EnvVarConfig.variable | string |Name of the environment variable |
79-
| EnvVarConfig.value | string |Value associated with the environment variable |
80-
| EnvVarConfig.availability | RUNTIME | Where the variable will be available. For now this will always be RUNTIME |
81-
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.
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. |
72+
| `environmentVariables`| `EnvVarConfig[]` | Environment variables present in the server execution environment.|
73+
| `concurrency` | `number` | The maximum number of concurrent requests that each server instance can receive.|
74+
| `cpu` | `number` |The number of CPUs used in a single server instance. |
75+
| `memoryMiB` | `number` | The amount of memory available for a server instance.|
76+
| `minInstance` | `number` |The limit on the minimum number of function instances that may coexist at a given time. |
77+
| `MaxInstance` | `number` | The limit on the maximum number of function instances that may coexist at a given time.|
78+
| `EnvVarConfig.variable` | `string` |Name of the environment variable |
79+
| `EnvVarConfig.value` | `string` |Value associated with the environment variable |
80+
| `EnvVarConfig.availability` | `RUNTIME` | Where the variable will be available. For now this will always be `RUNTIME` |
81+
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

@@ -95,12 +95,12 @@ interface Metadata {
9595

9696
| Field | Type | Description |
9797
| ---------- | ------- | - |
98-
| adapterPackageName | string |Name of the adapter (this should be the npm package name) |
99-
| adapterVersion| string | Version of the adapter|
100-
| framework | string | Name of the framework that is being supported|
101-
| frameworkVersion | string |Version of the framework that is being supported |
98+
| `adapterPackageName` | `string` |Name of the adapter (this should be the npm package name) |
99+
| `adapterVersion`| `string` | Version of the adapter|
100+
| `framework` | `string` | Name of the framework that is being supported|
101+
| `frameworkVersion` | `string` |Version of the framework that is being supported |
102102

103-
Here is a sample bundle.yaml file putting all this together:
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 framework that supports server side rendering.
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.

packages/firebase-frameworks/README.md

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)