Skip to content

Docs update for includeFiles and excludeFiles options on netlify adapter #10760

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

Merged
merged 7 commits into from
Feb 13, 2025

Conversation

dfdez
Copy link
Contributor

@dfdez dfdez commented Jan 22, 2025

Description:
Docs update for withastro/astro#13194.

Note

This PR remains in draft status pending the merge of these options into the adapter. I will mark it as ready for review once the changes are deployed to production.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 22, 2025
@astrobot-houston
Copy link
Contributor

astrobot-houston commented Jan 22, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/integrations-guide/netlify.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@dfdez dfdez changed the title Added for update netlify adapter to integrate includeFiles and excludeFiles options Docs update for includeFiles and excludeFiles options on netlify adapter Jan 22, 2025
@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

Copy link

netlify bot commented Jan 22, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit ef51945
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/67ad4cea2408480008a5c130
😎 Deploy Preview https://deploy-preview-10760--astro-docs-2.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.

@sarah11918 sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Jan 22, 2025
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thank you for submitting these docs for your feature! I've made a few suggestions below to conform to our style and language use. And, I think the examples should all refer to netlify here and not vercel, right? 😄

Also, please remove the translation file. We have a process for translation, and our PR template reminds you that you should only make a PR in one language. Thank you for following our system!

I'm looking forward to having this feature in docs!

For Team Docs looking at this PR: this PR highlights that the Netlify and Vercel docs are structured a little differently. (The Vercel documentation lists these as configuration options, whereas the Netlify docs are more "topic based." We can't fix that in this PR, but we may want to eventually move to consistency between the two! 😅

@sarah11918
Copy link
Member

Also noting that the implementation PR changeset includes information that should be in docs itself, so we will need to work this in:

The includedFiles and excludedFiles options allow you specify these inclusions and exclusions as an array of file paths relative to the site root. Both options support glob patterns, so you can include/exclude multiple files at once.

@github-actions github-actions bot removed the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 30, 2025
@dfdez
Copy link
Contributor Author

dfdez commented Jan 30, 2025

Hey @sarah11918 thanks for the feedback!

I've updated the examples to reference Netlify instead of Vercel and removed the translation file as requested.

I've also added more information to the docs as requested. Let me know if there's anything else needed 👍🏽

@dfdez dfdez requested a review from sarah11918 January 30, 2025 23:08
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Just a quick note these are in really good shape, and I'm waiting on the implementation PR to be reviewed/approved (just to make sure there's no new info/nothing changes) before doing a final polish here! 🫡

@sarah11918
Copy link
Member

Also noting that now that we've moved the adapters, this shouldn't affect the docs we've got going here, but we will need to update the PR description so we can link to the new PR to the main Astro repo instead of the closed adapters repo PR! 🙌

@sarah11918
Copy link
Member

Thanks for updating the description to link to the new withastro/astro PR!

Reminder (for all of us) that these docs will then still need final polishing once they are out of draft, when I'll compare to the implementation PR itself, the changeset there etc.! 🙌

@dfdez
Copy link
Contributor Author

dfdez commented Feb 10, 2025

Important comment made on the implementation PR that we should consider for the docs to 👍

@ematipico ematipico added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Feb 11, 2025
@ematipico
Copy link
Member

@sarah11918 I added the relative code PR to the next release 5.3.0

@sarah11918 sarah11918 added this to the 5.3.0 milestone Feb 11, 2025
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Looks great! Just some polishing changes, including making the additions more like our standard API reference. (I know, this is an older page that hasn't yet been updated in other entries, but let's at least get this one in shape!)

Please do check for accuracy!

@sarah11918 sarah11918 added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Feb 11, 2025
@dfdez
Copy link
Contributor Author

dfdez commented Feb 12, 2025

Hey @sarah11918 thanks for the feedback again!

I have made a commit including all the suggested changes 👌

@dfdez dfdez marked this pull request as ready for review February 12, 2025 21:54
@dfdez dfdez requested a review from sarah11918 February 12, 2025 21:59
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks so much for the updates, and thanks for also importing that <Since /> component! Welcome to Team Docs! 🥳

@sarah11918 sarah11918 changed the base branch from main to 5.3.0 February 13, 2025 01:41
@sarah11918 sarah11918 merged commit 921f503 into withastro:5.3.0 Feb 13, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants