Skip to content
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.

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

docs: add a language specific guide for Bun #20936

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

Pradumnasaraf
Copy link
Contributor

Description

Add language specfic guide for Bun

Related issues or tickets

Closes #20796

Reviews

  • Technical review
  • Editorial review
  • Product review

Copy link

netlify bot commented Sep 19, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 29fc291
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/670f92abed65cf000879d2f1
😎 Deploy Preview https://deploy-preview-20936--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Pradumnasaraf Pradumnasaraf changed the title Add bun user guide docs: add language specfic guide for Bun Sep 19, 2024
@Pradumnasaraf Pradumnasaraf marked this pull request as draft September 19, 2024 06:49
@Pradumnasaraf Pradumnasaraf changed the title docs: add language specfic guide for Bun docs: add a language specific guide for Bun Sep 19, 2024
@Pradumnasaraf Pradumnasaraf marked this pull request as ready for review September 19, 2024 07:11
@Pradumnasaraf
Copy link
Contributor Author

Pradumnasaraf commented Sep 19, 2024

Ready for review

(Apologies for above mess) Wow, there was a lot of conflict and logical change. I think docs have changed how it resolves the path plus folder structure.

content/guides/language/bun/_index.md Outdated Show resolved Hide resolved
content/guides/language/bun/containerize.md Outdated Show resolved Hide resolved
content/guides/language/bun/develop.md Outdated Show resolved Hide resolved
@Pradumnasaraf
Copy link
Contributor Author

Thanks for the review, @dvdksn. Updated the requested changes.

Copy link
Collaborator

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like tests are failing, could you check your links?

Also, I would like us to add a bit more detail to this guide. Other than the sample project, it doesn't contain any information or examples specific to Docker+Bun. Is there something more we can say about developing with Docker and Bun that might be useful to add here? For example, if there are differences between how the official node image and the oven/bun work, or if there's anything to keep in mind w.r.t. cache mounts, etc.

@Pradumnasaraf
Copy link
Contributor Author

Pradumnasaraf commented Sep 25, 2024

Hey, @dvdksn,

The links are fine I double-checked. Could you point out which link is creating the issue? Also, I checked the error in Workflow it seems something different

16.00 Total in 15907 ms
16.00 Error: error building site: logged 1 error(s)
------
Dockerfile:45
--------------------
  43 |     # DOCS_URL sets the base URL for the site
  44 |     ARG DOCS_URL
  45 | >>> RUN hugo --gc --minify -d /out -e $HUGO_ENV -b $DOCS_URL
  46 |     
  47 |     # lint lints markdown files
--------------------
ERROR: failed to solve: process "/bin/sh -c hugo --gc --minify -d /out -e $HUGO_ENV -b $DOCS_URL" did not complete successfully: exit code: 1
Build references
Check build summary support
Error: buildx bake failed with: ERROR: failed to solve: process "/bin/sh -c hugo --gc --minify -d /out -e $HUGO_ENV -b $DOCS_URL" did not complete successfully: exit code: 1

I was thinking of adding more content to this guide in another PR and was thinking of this one to go live and iterate over it. But, I will add more details to this PR itself. Thnak you.

@usha-mandya
Copy link
Member

Thanks @Pradumnasaraf. Let's add the details to this PR.

@dvdksn
Copy link
Collaborator

dvdksn commented Sep 25, 2024

The actual error is a bit obstructed in the logs;

#22 2.371 ERROR [en] REF_NOT_FOUND: Ref "/manuals/compose/file-watch.md" from page "/guides/language/bun/develop": page not found

@Pradumnasaraf
Copy link
Contributor Author

Hey,

#22 2.371 ERROR [en] REF_NOT_FOUND: Ref "/manuals/compose/file-watch.md" from page "/guides/language/bun/develop": page not found

I checked the page is there and the same link is added to other guides as well. I am not sure why it's giving an error. It's working fine as well when running locally.

Plus, I have updated the guide, let me know if you have any more feedback. Thanks!

@Pradumnasaraf
Copy link
Contributor Author

Hey, @dvdksn

Can you please have a look as the file/folder structure again changed and makes it hard to resolve merge conflicts?

@dvdksn
Copy link
Collaborator

dvdksn commented Oct 11, 2024

@Pradumnasaraf yep, taking a look

@Pradumnasaraf
Copy link
Contributor Author

Pradumnasaraf commented Oct 11, 2024

@Pradumnasaraf yep, taking a look

Thank you. I think this commit push, will sort out the build issue thing.

EDIT: It didn't

@dvdksn dvdksn force-pushed the add-bun-user-guide branch 2 times, most recently from 115111b to 49f1b81 Compare October 11, 2024 09:19
@Pradumnasaraf
Copy link
Contributor Author

I think everything looks fine and good to merge.

Thank you for the fixes @dvdksn.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn force-pushed the add-bun-user-guide branch from 49f1b81 to 29fc291 Compare October 16, 2024 10:17
@dvdksn
Copy link
Collaborator

dvdksn commented Oct 16, 2024

Pushed a minor editorial/refactoring on the bun intro prose, and a few other nits. Let's get this in! Thanks @Pradumnasaraf

@dvdksn dvdksn merged commit 970eb66 into docker:main Oct 16, 2024
14 checks passed
@Pradumnasaraf
Copy link
Contributor Author

Pushed a minor editorial/refactoring on the bun intro prose, and a few other nits. Let's get this in! Thanks @Pradumnasaraf

Thank you, David. I think it will take some time to show up on the docs page!

@dvdksn
Copy link
Collaborator

dvdksn commented Oct 16, 2024

@Pradumnasaraf I just kicked the publishing workflow, so the guide should be available in a few minutes from now 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add language specific guide for Bun
4 participants