chore: move deployment docs to separate documents #869
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Changes requested. Reviewed everything up to 33378fc in 31 seconds
More details
- Looked at
664lines of code in10files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_D9Z6kaFGAujny1zw
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
marcklingen
commented
Oct 16, 2024
There was a problem hiding this comment.
@clemra what do you think about this change? Over time these guides will get a lot longer and separating them gives them room without blowing up our self-hosted docs
marcklingen
commented
Oct 16, 2024
There was a problem hiding this comment.
@clemra what do you think about this change? Over time these guides will get a lot longer and separating them gives them room without blowing up our self-hosted docs
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
📦 Next.js Bundle Analysis for langfuse-docsThis analysis was generated by the Next.js Bundle Analysis action. 🤖 New Pages AddedThe following pages were added to the bundle from the code in this PR:
Three Hundred Thirty Pages Changed SizeThe following pages changed size from the code in this PR compared to its base branch:
DetailsOnly the gzipped size is provided here based on an expert tip. First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If Any third party scripts you have added directly to your app using the The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Disclaimer: Experimental PR review
PR Summary
This pull request reorganizes and expands the deployment documentation for Langfuse, improving accessibility and clarity for users deploying on various platforms.
- Added new platform-specific guides in
/pages/docs/deployment/platform-guides/for AWS, Azure, GCP, Heroku, Railway, and Porter.run - Created
/components-mdx/deployment-guide-callout.mdxfor consistent deployment information across guides - Updated
/pages/docs/deployment/self-host.mdxto remove platform-specific details and link to new guides - Added metadata files (
_meta.tsx) in/pages/docs/deployment/and/pages/docs/deployment/platform-guides/for improved navigation
10 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
|
|
||
| 5. **Set the environment variables** | ||
|
|
||
| For the minimum deployment in heroku, you will have to set the following environment variables (see table above). The `DATABASE_URL` is your database connection string starting with `postgres://` in the configuration of your added PostgreSQL database. |
There was a problem hiding this comment.
logic: Reference to 'table above' is incorrect as there is no table in this document
| SALT= | ||
| ``` | ||
|
|
||
| Have a look at the other optional environment variables in the table above and set them if needed to configure your deployment. |
There was a problem hiding this comment.
logic: Again, reference to 'table above' is incorrect
There was a problem hiding this comment.
Disclaimer: Experimental PR review
PR Summary
(updates since last review)
This pull request continues to refine and expand the deployment documentation for Langfuse, focusing on platform-specific guides and consistency across documentation.
- Updated
components-mdx/deployment-guide-callout.mdxwith improved wording and clarity for deployment guide disclaimers - Refined platform-specific deployment guides in
pages/docs/deployment/platform-guides/directory - Enhanced the self-hosting documentation in
pages/docs/deployment/self-host.mdxto better complement the new platform-specific guides - Ensured consistent use of the new
DeploymentGuideCalloutcomponent across platform-specific guides
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
📦 Next.js Bundle Analysis for langfuse-docsThis analysis was generated by the Next.js Bundle Analysis action. 🤖 New Pages AddedThe following pages were added to the bundle from the code in this PR:
Three Hundred Thirty Pages Changed SizeThe following pages changed size from the code in this PR compared to its base branch:
DetailsOnly the gzipped size is provided here based on an expert tip. First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If Any third party scripts you have added directly to your app using the The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored. |
📦 Next.js Bundle Analysis for langfuse-docsThis analysis was generated by the Next.js Bundle Analysis action. 🤖 New Pages AddedThe following pages were added to the bundle from the code in this PR:
Three Hundred Thirty Pages Changed SizeThe following pages changed size from the code in this PR compared to its base branch:
DetailsOnly the gzipped size is provided here based on an expert tip. First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If Any third party scripts you have added directly to your app using the The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored. |
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.
Important
Reorganized deployment documentation by moving platform-specific guides to separate files for improved clarity.
self-host.mdxto individual files inplatform-guides/directory.deployment-guide-callout.mdxfor consistent callout messages across platform guides.aws.mdx,azure.mdx,google-cloud-platform.mdx,heroku.mdx,porter.mdx,railway.mdxfor respective platform deployment guides._meta.tsxindeploymentandplatform-guidesto include new platform-specific guide entries.This description was created by
for 33378fc. It will automatically update as commits are pushed.