Skip to content

Commit b12ea67

Browse files
committed
fix review comments
1 parent a995e9f commit b12ea67

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

docs/source/routing/self-hosted/managed-hosting/railway.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The fastest way to deploy the Apollo Router on Railway is using the official tem
2626

2727
1. **Deploy the template**:
2828
- Visit the [Apollo Router Template repository](https://github.com/apollographql/router-template)
29-
- Click the "Deploy on Railway" button: [![Deploy on Railway](https://railway.app/button.svg)](https://railway.com/deploy/apollo-router)
29+
- Click the **Deploy on Railway** button: [![Deploy on Railway](https://railway.app/button.svg)](https://railway.com/deploy/apollo-router)
3030

3131
2. **Configure your deployment**:
3232
- **Template Name**: Enter a name for your deployment (e.g., `my-apollo-router`)
@@ -82,23 +82,23 @@ The Apollo Runtime container provides a production-ready router with sensible de
8282
- Select **Deploy from GitHub repo**
8383
- Connect and authorize your GitHub repository
8484

85-
2. **Configure the service**:
86-
- Railway will automatically detect your Dockerfile and configure the service
87-
- The build and deployment process will start automatically
85+
2. **Railway automatically configures the service**:
86+
- Railway detects your Dockerfile and configures the service
87+
- The build and deployment process starts automatically
8888

8989
3. **Set environment variables**:
9090
- In your project dashboard, go to the **Variables** tab
9191
- Add `APOLLO_KEY` and set it to your Graph API key
9292
- Add `APOLLO_GRAPH_REF` and set it to your graph reference
9393
- Railway automatically provides the `PORT` variable
9494

95-
4. **Deploy**: Railway will automatically deploy your service after setting the environment variables
95+
4. **Automatic deployment**: Railway automatically redeploys your service when environment variables are added
9696

9797
## Apollo MCP Server
9898

9999
The Apollo Runtime container includes an optional MCP (Model Context Protocol) server that provides AI assistants with structured access to your GraphQL schema and operations.
100100

101-
### Enabling MCP Server
101+
### Enable the MCP Server
102102

103103
The MCP server is disabled by default. To enable it, set the `MCP_ENABLE` environment variable to `1`:
104104

@@ -111,14 +111,14 @@ The MCP server is disabled by default. To enable it, set the `MCP_ENABLE` enviro
111111

112112
When enabled, the MCP server provides:
113113
- Schema introspection capabilities for AI assistants
114-
- Structured access to GraphQL operations
114+
- Structured access to GraphQL operations
115115
- Enhanced development experience with AI tools
116116

117117
## Configuration options
118118

119119
### Environment variables
120120

121-
The router accepts several environment variables for configuration:
121+
The router accepts multiple environment variables for configuration:
122122

123123
- `APOLLO_KEY`: Your Graph API key (required)
124124
- `APOLLO_GRAPH_REF`: Your graph reference (required)
@@ -195,7 +195,7 @@ Railway automatically handles scaling based on your usage:
195195
### Common issues
196196

197197
1. **Service won't start**:
198-
- Check that `APOLLO_KEY` and `APOLLO_GRAPH_REF` are correctly set in the Variables tab
198+
- Check that `APOLLO_KEY` and `APOLLO_GRAPH_REF` are correctly set in the **Variables** tab
199199
- Verify your graph exists in GraphOS Studio
200200
- Check deployment logs in the Railway dashboard
201201

@@ -211,7 +211,7 @@ Railway automatically handles scaling based on your usage:
211211
- Check that your Dockerfile is valid and the base image is accessible
212212
- Review build logs in the Railway dashboard for specific error messages
213213

214-
### Getting help
214+
### Get help
215215

216216
- Check the [Railway documentation](https://docs.railway.app/) for platform-specific issues
217217
- Visit the [Apollo Router documentation](/router) for router configuration

docs/source/routing/self-hosted/managed-hosting/render.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The fastest way to deploy the Apollo Router on Render is using the official temp
2626

2727
1. **Deploy the template**:
2828
- Visit the [Apollo Router Template repository](https://github.com/apollographql/router-template)
29-
- Click the "Deploy to Render" button: [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=github.com/apollographql/router-template)
29+
- Click the **Deploy to Render** button: [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=github.com/apollographql/router-template)
3030

3131
2. **Configure your service**:
3232
- **Service Name**: Enter a name for your router service (e.g., `my-apollo-router`)
@@ -106,7 +106,7 @@ The Apollo Runtime container provides a production-ready router with sensible de
106106

107107
2. **Configure the service**:
108108
- **Runtime**: Docker
109-
- **Build Command**: Leave empty (Docker will handle the build)
109+
- **Build Command**: Leave empty (Docker handles the build)
110110
- **Start Command**: Leave empty (defined in Dockerfile)
111111

112112
3. **Set environment variables**:
@@ -120,7 +120,7 @@ The Apollo Runtime container provides a production-ready router with sensible de
120120

121121
The Apollo Runtime container includes an optional MCP (Model Context Protocol) server that provides AI assistants with structured access to your GraphQL schema and operations.
122122

123-
### Enabling MCP Server
123+
### Enable the MCP Server
124124

125125
The MCP server is disabled by default. To enable it, set the `MCP_ENABLE` environment variable to `1`:
126126

@@ -148,7 +148,7 @@ When enabled, the MCP server provides:
148148

149149
### Environment variables
150150

151-
The router accepts several environment variables for configuration:
151+
The router accepts multiple environment variables for configuration:
152152

153153
- `APOLLO_KEY`: Your Graph API key (required)
154154
- `APOLLO_GRAPH_REF`: Your graph reference (required)
@@ -171,7 +171,7 @@ To use a custom domain with your Render deployment:
171171

172172
## Security considerations
173173

174-
**Important security settings to review before production deployment:**
174+
Important security settings to review before production deployment:
175175

176176
### CORS Configuration
177177
The template includes development-friendly CORS settings that may not be suitable for production:
@@ -196,7 +196,7 @@ cors:
196196
## Monitoring and observability
197197

198198
### Render metrics
199-
Render provides built-in metrics for your service including:
199+
Render provides built-in metrics for your service:
200200
- CPU and memory usage
201201
- Request metrics
202202
- Response times
@@ -236,7 +236,7 @@ Render automatically handles scaling based on your service plan:
236236
- Verify your `APOLLO_KEY` has the correct permissions
237237
- Check that your `APOLLO_GRAPH_REF` format is correct (e.g., `graph-name@variant`)
238238

239-
### Getting help
239+
### Get help
240240

241241
- Check the [Render documentation](https://render.com/docs) for platform-specific issues
242242
- Visit the [Apollo Router documentation](/router) for router configuration

0 commit comments

Comments
 (0)