You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-4Lines changed: 0 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -16,10 +16,6 @@ Each Function lives in its own directory within this repo. The easiest way to us
16
16
17
17
[Complete list of available functions](docs/templates.md)
18
18
19
-
## Github Pages
20
-
21
-
The Quick Deploy Functions in this repo contain an `index.html` asset that is displayed after a deployment succeeds. That `index.html` file is served by the Function itself, but several static assets shared by every `index.html` are served by Github Pages from the `/docs/static` directory of this repo. These files all follow [semver](https://semver.org/) versioning, and are located in a subdirectory of `/docs/static` named after their semver major version number. For example, a file of version `1.2.3` should have a comment header containing `Version: 1.2.3` (if possible), and be located in the `v1` subdirectory of `/docs/static`.
22
-
23
19
### Todo
24
20
25
21
-[ ] Forward message to email with other API providers
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+23-3Lines changed: 23 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -90,11 +90,31 @@ If you _do not_ want an environment variable to appear on the CodeExchange page,
90
90
91
91
**Note**: All function templates are checked for the presence of a `.env.example` or a `.env` file by `npm test`. If a test named `should have a .env.example (or .env) file` fails, ensure that your function template's `.env` file exists and `git add` has been used to add it to your commit. If your function template lacks environment variables, commit an empty `.env` file. If the test is failing due to a directory that is not a function template, add that directory to the `excludedPaths` variable in `test/all-templates.test.js`.
92
92
93
-
### Updating the `index.html`
93
+
##The `index.html` file
94
94
95
-
If your app has a front-end component to it, you can override the existing `index.html` file in your project.
95
+
The Quick Deploy Functions in this repo contain an `index.html` asset that is displayed after a deployment succeeds. That `index.html` file is served by the Function itself.
96
96
97
-
In case your app does not contain a front-end component you should update the `index.html` file to reflect what steps a customer should perform to make the app work, once your template has been deployed.
97
+
If your app has a front-end component to it, you can override the existing `index.html` file in your project, and if it doesn't you should update the `index.html` file to reflect what steps a customer should perform to make the app work once your template has been deployed.
98
+
99
+
### Github Pages
100
+
Several static assets shared by every `index.html` are served by Github Pages from the `/docs/static` directory of this repo. These files all follow [semver](https://semver.org/) versioning, and are located in a subdirectory of `/docs/static` named after their semver major version number. For example, a file of version `1.2.3` should have a comment header containing `Version: 1.2.3` (if possible), and be located in the `v1` subdirectory of `/docs/static`.
101
+
102
+
### Helpers
103
+
In the shared `/docs/static` folder there's JavaScript and CSS helpers to achieve things like:
104
+
- Style buttons, inputs and general elements on the page based on the [Paste design system](https://paste.twilio.design/).
105
+
- Prepend the Base URL of functions to inputs
106
+
- Handle Copy to Clipboard on inputs
107
+
108
+
### Server-rendered elements
109
+
These comments will be replaced at build time and will result in the following:
0 commit comments