Refactor functions docs #433

gewenyu99 · 2023-12-19T22:28:16Z

What does this PR do?

Refactor some of function docs, so they're easier to digest

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

render · 2023-12-19T22:28:20Z

Your Render PR Server URL is https://appwrite-pr-433.onrender.com.

Follow its progress at https://dashboard.render.com/web/srv-cm11i0md3nmc739v9llg.

vercel · 2023-12-19T22:28:22Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
website	❌ Failed (Inspect)			Dec 22, 2023 5:37am

render · 2024-01-24T23:21:49Z

Your Render PR Server URL is https://appwrite-io-docker-pr-433.onrender.com.

Follow its progress at https://dashboard.render.com/web/srv-cmopn2q1hbls739b09h0.

eldadfux · 2024-02-01T15:06:29Z

static/images/docs/platform/execution-details.png

The logs background here looks like a bug. I'm pretty sure it should be dark.

I added it to an issue. It is

Meldiron · 2024-02-02T12:46:34Z

src/routes/docs/products/functions/quick-start/+page.markdoc

+{% cards_item href="/docs/products/functions/execution" title="Execute" %}
+Appwrite Functions can be executed in a variety of ways, like SDK, domains, schedules, events, and more. Learn about executions.
+{% /cards_item %}
+{% cards_item href="/docs/products/functions/execution#domains" title="Domains" %}


I tried and most of the links don't work

Oh yeah I broke all these.

Meldiron · 2024-02-02T12:47:39Z

src/routes/docs/products/functions/functions/+page.markdoc

+description: Learn what an Appwrite Function can do for you and how to create a new Appwrite Function
+---
+
+Each Appwrite Function is a piece of user defined code that can be executed on demand.


I wouldnt call it user-defined. either deveoper-defined, or defined by you.
User-defined sounds like end user

Meldiron · 2024-02-02T12:48:33Z

src/routes/docs/products/functions/functions/+page.markdoc

+Each Appwrite Function is a piece of user defined code that can be executed on demand.
+When you create a new Appwrite Function, you select a name, ID, and [runtime language](/docs/products/functions/runtimes).
+
+Each time a function changes, a [deployment](/docs/products/functions/deployments) is created, which is like a version of a function.


Suggested change

Each time a function changes, a [deployment](/docs/products/functions/deployments) is created, which is like a version of a function.

Each time a function's code changes, a [deployment](/docs/products/functions/deployments) is created, which is like a version of a function.

Meldiron · 2024-02-02T12:48:56Z

src/routes/docs/products/functions/functions/+page.markdoc

+{% /tabsitem %}
+
+{% tabsitem #cli title="CLI" %}
+You can create functions using the CLI, without needing to access the console.


Suggested change

You can create functions using the CLI, without needing to access the console.

You can create functions using the CLI, without needing to access the Console.

Meldiron · 2024-02-02T12:50:21Z

src/routes/docs/products/functions/functions/+page.markdoc

+{% /tabsitem %}
+{% /tabs %}
+
+After creating your function, create a [deployment](/docs/products/functions/deployments) to add code to the function.


In all tabs it also explains how to make first deployment. I don't think we need this sentence

Meldiron · 2024-02-02T12:50:53Z

src/routes/docs/products/functions/functions/+page.markdoc

+{% tabsitem #manual title="Manual" %}
+You can also create Appwrite Functions manually by uploading your code in a zipped file.
+In the **Create Function** modal, click **create a function manually** at the bottom to switch to manual create wizard.
+You will asked to upload a zip file with your code.


Suggested change

You will asked to upload a zip file with your code.

You will be asked to upload a zip file with your code.

Meldiron · 2024-02-02T12:51:52Z

src/routes/docs/products/functions/functions/+page.markdoc

+└── index.js
+```
+
+Package your code files into the `.tar.gz` format. **Don't include your dependencies folder**, such as **node_modules**.


Suggested change

Package your code files into the `.tar.gz` format. **Don't include your dependencies folder**, such as **node_modules**.

Package your code files into the `.tar.gz` format. **Don't include your dependencies folder**, such as node_modules.

Too much boldness, this makes it better

Meldiron · 2024-02-02T12:53:26Z

src/routes/docs/products/functions/functions/+page.markdoc

+1. In the Appwrite Console's sidebar, click **Functions**.
+2. Click **Create function**.
+3. Connect your project to a Git repository. Your functions will build and deploy when the repository receives a push.
+4. If you already have a repository containing an Appwrite Function, connect to it under **Connect Git repository**. 


Suggested change

4. If you already have a repository containing an Appwrite Function, connect to it under **Connect Git repository**.

4. If you already have a repository containing an Appwrite Function, select it under **Connect Git repository**.

Meldiron · 2024-02-02T12:54:47Z

src/routes/docs/products/functions/functions/+page.markdoc

+This lets you track your code using Git, which makes it easy to integrate Appwrite Functions into your existing code base.
+1. In the Appwrite Console's sidebar, click **Functions**.
+2. Click **Create function**.
+3. Connect your project to a Git repository. Your functions will build and deploy when the repository receives a push.


Suggested change

3. Connect your project to a Git repository. Your functions will build and deploy when the repository receives a push.

3. Connect your project to your Git provider. You will be asked to authorize Appwrite and grant access to some resources necessary for the Git deployments to work.

Meldiron · 2024-02-02T12:57:03Z

src/routes/docs/products/functions/functions/+page.markdoc

+When you update a function's runtime, the code of your function may not be compatible with the new runtime.
+Remember to update your code and redeploy your function.


Suggested change

When you update a function's runtime, the code of your function may not be compatible with the new runtime.

Remember to update your code and redeploy your function.

When you update a function's runtime, you may need to update code of your function to make it compatible with the new runtime.

Above we already have big alert box teiing to redeploy.

PineappleIOnic · 2024-02-13T15:29:51Z

src/routes/docs/products/functions/develop/+page.markdoc

We probably want to add something to the Request section here noting that req.body will contain the object of the event that invoked it, like for buckets.*.files.*.create it'll contain the file that triggered that event

PineappleIOnic · 2024-02-13T15:31:31Z

src/routes/docs/products/functions/execute/+page.markdoc

@@ -464,7 +464,7 @@ You'll be able to mock executions by configuring the path, method, headers, and
 {% /only_light %}


-## Events {% #events %}
+# Events {% #events %}

 Changes in Appwrite emit events. You can configure Functions to be executed in response to these events.


Same thing here for the events section, we should explain that the event trigger can be found in x-appwrite-event header and the body will contain the data of the resource that triggered it

PineappleIOnic · 2024-02-29T11:48:32Z

src/partials/auth-events.md

+* 
+    This event triggers when a verification token for a user is validated.
+    Returns [Token Object](/docs/references/cloud/models/token)


We need to make sure we have the 1.5 events

Oi, review this: appwrite/appwrite#7744

PineappleIOnic · 2024-02-29T11:54:53Z

src/routes/docs/products/functions/develop/+page.markdoc

-2. Appwrite passes in request information like headers, body or path through the `context.req` object.
-3. The runtime executes the code you defined, you can log through the `context.log()` or `context.error()` methods.
-4. Function terminates when you return results using `return context.res.send()`, `return context.res.json()` or similar.
+1. The active [deployment](/docs/products/functions/deploy)'s executor will handle the request.


These steps are all 1.

Yes markdown renders them as 1.2.3.4 ;) This in fact works

PineappleIOnic · 2024-02-29T12:09:49Z

src/routes/docs/products/functions/domains/+page.markdoc

+
+# Generated domains {% #generated-domains %}
+
+1. In the Appwrite Console's sidebar, click **Functions**.


These steps are all 1.

Yes markdown renders them as 1.2.3.4 ;) This in fact works

PineappleIOnic · 2024-02-29T12:10:05Z

src/routes/docs/products/functions/execute/+page.markdoc

 1. In the Appwrite Console's sidebar, click **Functions**.
-1. Under the **Domains** tab, you'll find the generated domain from Appwrite and your custom domains.
+1. Under **Execute access**, set the access to `Any` so that anyone can execute the function. You will use [JWTs](/docs/products/auth/jwt) to authenticate users.
+1. Under the **Domains** tab, you'll find the generated domain from Appwrite and your custom domains. [Learn about adding a custom domain](/docs/products/functions/domains).


These steps all both 1.

Yes markdown renders them as 1.2.3.4 ;) This in fact works

PineappleIOnic · 2024-02-29T12:12:49Z

src/routes/docs/products/functions/templates/+page.markdoc

+---
+layout: article
+title: Templates
+description: Learn about Appwrite Functions' templates that let you jump start function development to extend your Appwrite APIs.


Could the ' in this description cause problems with the parser? I vaguely remember an issue like this, please check it doesn't result in a server error

I'll check :)

PineappleIOnic

Small issues here and there

src/routes/docs/products/functions/deployments/+page.markdoc

src/routes/docs/products/functions/develop/+page.markdoc

src/routes/docs/products/functions/domains/+page.markdoc

src/routes/docs/products/functions/execute/+page.markdoc

src/routes/docs/products/functions/functions/+page.markdoc

…/website into feat-functions-refactor

Refactor some of function docs, so they're easier to digest

1a792ab

Added deployments page

1442079

vercel bot had a problem deploying to Preview December 20, 2023 02:54 Failure

Add executions + fill bits of deployments

3c032d7

vercel bot had a problem deploying to Preview December 22, 2023 05:37 Failure

github-actions bot mentioned this pull request Jan 1, 2024

PRs Opened in December 2023 appwrite/.github#106

Closed

Merge branch 'main' into feat-functions-refactor

ec4e8f9

Vincent (Wen Yu) Ge and others added 3 commits January 24, 2024 23:30

Finish all concept pages

9afc6a6

Merge branch 'main' into feat-functions-refactor

3217c00

First draft of refactored function docs

835a609

gewenyu99 marked this pull request as ready for review January 29, 2024 03:15

gewenyu99 requested review from eldadfux, vermakhushboo and Meldiron January 29, 2024 03:16

eldadfux reviewed Feb 1, 2024

View reviewed changes

Meldiron reviewed Feb 2, 2024

View reviewed changes

PineappleIOnic reviewed Feb 13, 2024

View reviewed changes

Merge branch 'main' into feat-functions-refactor

3582fe6

PineappleIOnic self-requested a review February 29, 2024 11:39

PineappleIOnic reviewed Feb 29, 2024

View reviewed changes

PineappleIOnic suggested changes Feb 29, 2024

View reviewed changes

Fix one more link

bd7f80e

gewenyu99 changed the title ~~Refactor some of function docs, so they're easier to digest~~ Refactor functions docs Mar 13, 2024

gewenyu99 requested review from Meldiron and PineappleIOnic March 13, 2024 10:11

Merge branch 'main' into feat-functions-refactor

22501ed

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/deployments/+page.markdoc Outdated Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/develop/+page.markdoc Outdated Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/develop/+page.markdoc Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/domains/+page.markdoc Outdated Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/execute/+page.markdoc Outdated Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/execute/+page.markdoc Outdated Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/execute/+page.markdoc Outdated Show resolved Hide resolved

loks0n reviewed Mar 27, 2024

View reviewed changes

src/routes/docs/products/functions/functions/+page.markdoc Show resolved Hide resolved

Vincent (Wen Yu) Ge and others added 2 commits April 1, 2024 21:42

Add review comment fixes

1def068

Fix build error

9f58c9a

loks0n approved these changes Apr 2, 2024

View reviewed changes

gewenyu99 requested a review from loks0n April 2, 2024 14:24

fix wrong code tags

39b0766

loks0n approved these changes Apr 3, 2024

View reviewed changes

Vincent (Wen Yu) Ge added 2 commits April 3, 2024 15:24

Fix dead links

a363f5a

Merge branch 'feat-functions-refactor' of https://github.com/appwrite…

bbf2dc1

…/website into feat-functions-refactor

PineappleIOnic approved these changes Apr 3, 2024

View reviewed changes

gewenyu99 merged commit b0b2efa into main Apr 4, 2024
2 checks passed

	Each time a function changes, a [deployment](/docs/products/functions/deployments) is created, which is like a version of a function.
	Each time a function's code changes, a [deployment](/docs/products/functions/deployments) is created, which is like a version of a function.

	You can create functions using the CLI, without needing to access the console.
	You can create functions using the CLI, without needing to access the Console.

	You will asked to upload a zip file with your code.
	You will be asked to upload a zip file with your code.

	Package your code files into the `.tar.gz` format. Don't include your dependencies folder, such as node_modules.
	Package your code files into the `.tar.gz` format. Don't include your dependencies folder, such as node_modules.

	4. If you already have a repository containing an Appwrite Function, connect to it under Connect Git repository.
	4. If you already have a repository containing an Appwrite Function, select it under Connect Git repository.

	3. Connect your project to a Git repository. Your functions will build and deploy when the repository receives a push.
	3. Connect your project to your Git provider. You will be asked to authorize Appwrite and grant access to some resources necessary for the Git deployments to work.

		When you update a function's runtime, the code of your function may not be compatible with the new runtime.
		Remember to update your code and redeploy your function.

	When you update a function's runtime, the code of your function may not be compatible with the new runtime.
	Remember to update your code and redeploy your function.
	When you update a function's runtime, you may need to update code of your function to make it compatible with the new runtime.


		# Generated domains {% #generated-domains %}

		1. In the Appwrite Console's sidebar, click Functions.

Refactor functions docs #433

Refactor functions docs #433

Conversation

gewenyu99 commented Dec 19, 2023

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

render bot commented Dec 19, 2023

vercel bot commented Dec 19, 2023 • edited Loading

render bot commented Jan 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PineappleIOnic Feb 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PineappleIOnic left a comment • edited Loading

Choose a reason for hiding this comment

vercel bot commented Dec 19, 2023 •

edited

Loading

PineappleIOnic Feb 29, 2024 •

edited

Loading

PineappleIOnic left a comment •

edited

Loading