Docs/Self-hosting docs change with AWS EC2 and GCP#4131
Open
opemipodisu wants to merge 19 commits intomasterfrom
Open
Docs/Self-hosting docs change with AWS EC2 and GCP#4131opemipodisu wants to merge 19 commits intomasterfrom
opemipodisu wants to merge 19 commits intomasterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates ByteChef documentation with expanded self-hosting deployment guides (AWS EC2, GCP, Azure, Docker, Kubernetes), navigation/meta updates, and broad SEO frontmatter/title/formatting adjustments across the docs site.
Changes:
- Expanded self-hosting deployment and configuration docs (AWS EC2, GCP, Azure, Docker, Kubernetes; plus instance management pages).
- Updated navigation metadata (
meta.json) and added SEO-oriented frontmatter changes across many reference pages. - Added utility scripts intended to batch-edit frontmatter (canonical/SEO).
Reviewed changes
Copilot reviewed 245 out of 247 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| remove_canonicals.py | Adds a script to remove canonical from frontmatter across docs. |
| optimize_seo.py | Adds a script to generate/update SEO titles/descriptions/canonicals and produce a report. |
| docs/package-lock.json | Updates docs site dependencies but currently contains unresolved merge-conflict markers. |
| docs/content/docs/self-hosting/meta.json | Fixes self-hosting navigation entries (e.g., EC3 removal, Azure rename, instance section label). |
| docs/content/docs/self-hosting/deployment/local-docker.md | Replaces placeholder with Docker/Docker Compose deployment instructions. |
| docs/content/docs/self-hosting/deployment/kubernetes.md | Replaces placeholder with Kubernetes/Helm + quickstart instructions. |
| docs/content/docs/self-hosting/deployment/aws-ec2.md | Adds AWS EC2 deployment steps (Docker-based). |
| docs/content/docs/self-hosting/deployment/google-cloud.md | Adds GCP Compute Engine deployment steps (Docker-based). |
| docs/content/docs/self-hosting/deployment/azure.md | Adds Azure VM deployment steps (Docker-based). |
| docs/content/docs/self-hosting/deployment/digitalocean.md | Updates frontmatter (still “coming soon” content). |
| docs/content/docs/self-hosting/deployment/aws-ec3.md | Removes the incorrect AWS EC3 page. |
| docs/content/docs/self-hosting/configuration/configure-instance.md | Adds content describing how configuration via env vars works across platforms. |
| docs/content/docs/self-hosting/configuration/environment-variables.md | Updates frontmatter description. |
| docs/content/docs/self-hosting/configuration/manage-instance.md | Adds substantial operational/observability/management content. |
| docs/content/docs/reference/index.mdx | Updates reference landing frontmatter and formatting. |
| docs/content/docs/reference/expressions.md | Updates expressions frontmatter but currently contains unresolved merge-conflict markers. |
| docs/content/docs/reference/flow-controls/* | Mostly frontmatter/formatting cleanups for flow-control reference pages. |
| docs/content/docs/reference/components/index.mdx | Reworks components index page content and frontmatter. |
| docs/content/docs/reference/components/* | Broad frontmatter/formatting updates across many component reference pages. |
| docs/content/docs/platform/overview.mdx | Updates platform overview frontmatter/text but currently contains unresolved merge-conflict markers. |
| docs/content/docs/openapi/index.mdx | Updates OpenAPI landing page title/description. |
| docs/content/docs/embedded/index.mdx | Updates embedded landing page title/description. |
| docs/content/docs/embedded/quickstart.mdx | Updates embedded quickstart frontmatter but currently contains unresolved merge-conflict markers. |
| docs/content/docs/developer-guide/index.mdx | Deletes developer-guide index frontmatter stub. |
| docs/content/docs/developer-guide/* | Frontmatter and formatting updates across developer guide pages; some files contain unresolved merge-conflict markers. |
| docs/content/docs/automation/meta.json | Updates automation nav structure but currently contains unresolved merge-conflict markers. |
| docs/content/docs/automation/connect-data/* | Adds “How-To Guides” section and updates connect-data overview/meta but currently contains unresolved merge-conflict markers. |
| docs/content/docs/(getting-started)/* | Updates getting-started pages/frontmatter but several files contain unresolved merge-conflict markers. |
Files not reviewed (1)
- docs/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Scans and optimizes all documentation pages for better SEO. | ||
| """ | ||
|
|
||
| import re |
There was a problem hiding this comment.
Import of 're' is not used.
| """ | ||
|
|
||
| import re | ||
| import os |
There was a problem hiding this comment.
Import of 'os' is not used.
| import re | ||
| import os | ||
| from pathlib import Path | ||
| from typing import Dict, List, Set, Optional |
There was a problem hiding this comment.
Import of 'Dict' is not used.
Import of 'List' is not used.
Import of 'Set' is not used.
Collaborator
There was a problem hiding this comment.
It would be better to put JSON of your workflow here as an example
Collaborator
There was a problem hiding this comment.
Link does not work
Collaborator
There was a problem hiding this comment.
Link does not work
Collaborator
There was a problem hiding this comment.
None of the links work
| ## Example Workflow | ||
|
|
||
| ``` | ||
| Typeform Trigger |
Collaborator
There was a problem hiding this comment.
Add workflow JSON as an example
- Fix broken links in architecture.mdx, what-is-bytechef.mdx, and quickstart.mdx - Update deployment links to point to correct paths - Update component links in how-to-guides to reference actual component pages - Remove embedded JSON from branch_v1.mdx (keeping external link) - Update authentication links to point to correct paths - Standardize link formatting across documentation
… merge conflict markers
- automation/monitor/index.mdx - platform/overview.mdx - developer-guide/build-component/initial-setup.mdx - developer-guide/build-component/create-trigger.mdx - embedded/quickstart.mdx
- Separate code blocks into focused sections with descriptive headings - Add bullet points explaining each operation - Update meta.json to include aws-ecs deployment option - Improve code readability and documentation structure
- Add PostgreSQL task definition with proper JSON structure - Add ByteChef task definition with environment variables - Include complete ECS deployment examples - Update upgrade section with detailed task definitions
opemipodisu
force-pushed
the
docs/aws-ec2-update
branch
from
6df69f0 to
080a2a0
Compare
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 16145489 | Triggered | Base64 Basic Authentication | 0290451 | client/codegen.ts | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
- Remove merge conflict markers from AWS EC2 deployment guide - Create clean file with proper content structure
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes # (issue)