Skip to content

Update azure functions docs #8176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mabuyo merged 2 commits into from
Apr 29, 2026
+380 −0

Apply suggestions from EDU review

719ae0a
Select commit
Loading
Failed to load commit list.
Merged

Update azure functions docs #8176

Apply suggestions from EDU review
719ae0a
Select commit
Loading
Failed to load commit list.
Apollo Librarian / AI Style Review succeeded Mar 6, 2026 in 25s

Style Review Completed

The pull request has 20 style issues.

Duration: 1695ms
PR URL: #8176
Review Log: View detailed log
Review Comments: The AI has posted 20 inline comments with suggestions

Summary of changes:

The pull request updates the documentation to align with several style guide sections. For Products and Features, it removes articles before standalone product names like Apollo Server, Azure Functions, and Apollo Sandbox. Structural changes include converting headings to sentence case, using imperative verbs for tutorial headings, and enforcing two-space indentation in JavaScript code blocks. Voice and tone improvements prioritize authoritative language over passive phrasing and prescribe TypeScript as the preferred path. Word usage updates replace 'utilizing' with 'use', 'several' with 'multiple', and ensure 'log in' is used as a verb. Formatting adjustments remove bolding from version numbers and apply code font to command names and localhost.

⚠️ This review and suggested changes are AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

Annotations

Check warning on line 3 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L3 

**Products and Features**: Remove 'the' before the standalone product name 'Apollo Server'.

```suggestion
description: How to deploy Apollo Server with Azure Functions
```

Check warning on line 66 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L66 

**Products and Features**: Remove 'the' before standalone product name Apollo Server.

```suggestion
// Set up Apollo Server
```

Check notice on line 12 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L12 

**Structural Elements**: Do not specify the number of items in a list introduction.

```suggestion
Make sure you've completed the following:
```

Check notice on line 20 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L20 

**Structural Elements**: Headings should use sentence case.

```suggestion
## Set up your project
```

Check notice on line 24 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L24 

**Structural Elements**: Headings should use sentence case.

```suggestion
### Create a new Azure Functions app
```

Check notice on line 28 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L28 

**Structural Elements**: Headings should use sentence case.

```suggestion
### Install dependencies
```

Check warning on line 39 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L39 

**Structural Elements**: Terminal commands longer than three words should be in a code block with a language specifier.

```suggestion
```bash
npm install -D typescript
```
```

Check notice on line 42 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L42 

**Structural Elements**: Headings should use sentence case.

```suggestion
### Create your GraphQL function
```

Check notice on line 160 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L160 

**Structural Elements**: List items that are fragments should omit ending punctuation.

```suggestion
- `req`: The [HttpRequest](https://learn.microsoft.com/javascript/api/@azure/functions/httprequest) object containing HTTP headers, method, body, query parameters, etc.
```

Check notice on line 161 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L161 

**Structural Elements**: List items that are fragments should omit ending punctuation.

```suggestion
- `context`: The [InvocationContext](https://learn.microsoft.com/javascript/api/@azure/functions/invocationcontext) object containing function execution context (trace context, retry context, etc.)
```

Check warning on line 164 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L164 

**Structural Elements**: Headings should use sentence case.

```suggestion
## Deployment
```

Check warning on line 168 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L168 

**Structural Elements**: Tutorial headings should use imperative verbs.

```suggestion
### Deploy with VS Code
```

Check notice on line 185 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L185 

**Structural Elements**: Terminal commands should have line numbering removed with showLineNumbers=false.

```suggestion
```bash showLineNumbers=false
func azure functionapp publish <YOUR_FUNCTION_APP_NAME>
```
```

Check warning on line 188 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L188 

**Structural Elements**: Tutorial headings should use imperative verbs.

```suggestion
### Use CI/CD
```

Check warning on line 234 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L234 

**Structural Elements**: Headings should use sentence case.

```suggestion
## Advanced patterns
```

Check warning on line 236 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L236 

**Structural Elements**: Conceptual overview headings should use gerunds.

```suggestion
### Authenticating and authorizing
```

Check warning on line 263 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L263 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
  // 1. Verify JWT signature
```

Check warning on line 264 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L264 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
  // 2. Check expiration
```

Check warning on line 265 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L265 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
  // 3. Look up user in database
```

Check warning on line 267 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L267 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
  // Mock implementation
```

Check warning on line 268 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L268 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
  if (token.startsWith('Bearer ')) {
```

Check warning on line 269 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L269 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
    const userId = token.replace('Bearer ', '');
```

Check warning on line 270 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L270 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
    // Look up user...
```

Check warning on line 271 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L271 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
    return { id: userId, name: 'User', email: 'user@example.com', roles: ['user'] };
```

Check warning on line 272 in docs/source/deployment/azure-functions.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/deployment/azure-functions.mdx#L272 

**Structural Elements**: Use two spaces for each indentation level in JavaScript code blocks.

```suggestion
  }
```
View more details on Apollo Librarian