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

Unflag content layer #11911

Merged
merged 4 commits into from
Sep 4, 2024
Merged

Unflag content layer #11911

merged 4 commits into from
Sep 4, 2024

Conversation

ascorbic
Copy link
Contributor

@ascorbic ascorbic commented Sep 3, 2024

Changes

Removes the experimental.contentLayer flag.

Fixes PLT-2450

Testing

Docs

Copy link

changeset-bot bot commented Sep 3, 2024

🦋 Changeset detected

Latest commit: 925aac6

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) docs pr semver: minor Change triggers a `minor` release labels Sep 3, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.


The Content Layer API introduced behind a flag in [4.14.0](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md#4140) is now stable and ready for use.

The Content Layer API is the next generation of content collections, allowing you to load content from anwhere. For more details, see the [content collections documentation](https://docs.astro.build/en/guides/content-collections/).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm assuming that this is where we'll have the content layer docs.

Copy link
Contributor

Choose a reason for hiding this comment

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

@sarah11918 said we shouldn't have these links because we're releasing minors and people might be confused that the pages don't exist.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The page does exist (it's the existing content collections docs), but it doesn't refer to content layer so it's true that may be confusing. I've asked for comment from docs peeps!

Copy link
Member

Choose a reason for hiding this comment

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

@ascorbic My main concern is avoiding broken links, but yes additionally, the link should actually have the content it claims! 😄

Some possible solutions:

Read more about [the Content Layer API](https://docs.astro.build/en/reference/configuration-reference/#experimentalcontentlayer) in our current documentation.

Or, if there will be content available at the time of merging on the beta branch:

Read more about [the Content Layer API](https://5-0-0-beta.docs.astro.build/en/guides/content-collections/#contentlayerapi) in our beta documentation.

Something like either of those would work, I think!

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.


The Content Layer API introduced behind a flag in [4.14.0](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md#4140) is now stable and ready for use.

The Content Layer API is the next generation of content collections, allowing you to load content from anwhere. For more details, see the [content collections documentation](https://docs.astro.build/en/guides/content-collections/).
Copy link
Member

@sarah11918 sarah11918 Sep 3, 2024

Choose a reason for hiding this comment

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

I will also note in general, it's is OK to hype the feature here! Many people do not try features until they are stable.

You can see this changeset for unflagging astro:env as an example, and my comments there. (You can pull from the original experimental changeset, or from existing config references, if you want!) #11679

PS - ignore the link used in this changeset. I edited it before the CHANGELOG was published so that it wouldn't be a broken link

PPS - I know this is just the alpha release one, but writing for it in prep for the stable release just means less editing when we do get there. We will proofread for links, and edit messages for the changelog as necessary prior to the beta/stable releases!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated it, largely based on the experimental changeset

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

export const collections = { podcasts };
```

To learn more, see [the Content Layer RFC](https://github.com/withastro/roadmap/blob/content-layer/proposals/0050-content-layer.md).
Copy link
Member

Choose a reason for hiding this comment

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

Not a big deal, but this link is here twice. I think it's fine to have in both places, since this is a longer changeset. It would also be fine to make one of the two links post to the blog post, for variety, if one link seems more about hyping and one seems more about digging into nuts and bolts.

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.

Approving for docs! Just pointed out two tiny things you may or may not care about. Let's Get That Money!

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ascorbic ascorbic merged commit c3dce83 into next Sep 4, 2024
14 checks passed
@ascorbic ascorbic deleted the cl-not-experimental branch September 4, 2024 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs pr pkg: astro Related to the core `astro` package (scope) semver: minor Change triggers a `minor` release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants