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

Revamp Content section 5.0 #9328

Merged
merged 49 commits into from
Sep 10, 2024
Merged

Revamp Content section 5.0 #9328

merged 49 commits into from
Sep 10, 2024

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Sep 7, 2024

New content (& content collections) section for 5.0

This PR:

  • updates the content collections guide, splitting it into a main landing page and two smaller guides
  • updates Markdown guide for freshness, streamlined-ness, and simplifies by removing MDX content (which has, already in live published docs, been moved to the MDX page itself)
  • updates a bunch of links that have shifted during the flight and other minor tweaks to give an overall "Content" refresh

Re: Content Collections (now, powered by a layer!) for @ascorbic

  1. Please review the three new content collections guide pages preview here:
    content-collections.mdx
    defining-collections.mdx
    working-with-collections.mdx

You can ignore everything else! It's just links etc. around the rest of the site because the original page (and a couple of other related content / markdown pages) have changed. There's also some future proofing for when collections don't have to be in src/content/

By "review" I mean:

  • correct any inaccuracies!
  • point out any wrong nuances, takes, or nudges that don't feel right to you
  • is anything key to using collections missing? We can always add more over time, but is there anything that's absolutely needed here or people are just not going to be successful?
  • if you happen to notice language stuff, then all proofreading, grammar, formatting etc. are fine here, but it's not required to take a specific pass or pay super close attention to this since there will still be lots of available eyes to catch that stuff.

My main goal is to make sure that this guide faithfully and accurately represents both how to get set up and use collections, and the "vision" for collections.

After, outside of this PR:

  1. I have added in this PR a shell for a new Loader API page. It seems like this should be a good place to document the Loader API in technical detail, and describe how to build one. You don't need to contribute to this branch. Once the guide content is fine, we can merge this branch and that shell page will exist. You can separately make a PR that will include:
  • content for the Loader API page
  • any updates to the API reference page, content collections section

Those two can be together in the same PR if you want, to get all the API content squared away.

My first priority is to get this PR merged into the beta branch so I can start fixing any conflicts because there were a lot of moving pieces in breaking up the content collections page! The API material can be added later!

Copy link

netlify bot commented Sep 7, 2024

Deploy Preview for astro-docs-2 ready!

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

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Sep 7, 2024
@sarah11918 sarah11918 marked this pull request as ready for review September 8, 2024 11:42
Copy link
Contributor

@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

I'm not Matt but I was curious so... 😀 Just two missing imports and an extra space. Otherwise it looks good to me! But again I'm not Matt and I don't know all the technical details.
(By the way, thanks @ascorbic for this feature! I already liked content collections but this one solves my organizational problem ❤️ )

src/content/docs/en/guides/working-with-collections.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/working-with-collections.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/working-with-collections.mdx Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member Author

OK! If no objections, I'd like to merge this one as a pretty much good enough, acknowledging that for Content Layer API there is still more to document (separately):

  • The api-reference page for content collections should be double checked and updated for content layer accuracy. No need to mention old collections at all, since I'll be providing a link to v4.0 docs for legacy users.

  • the Loader API page is just a stub right now. @ascorbic , I would love if you would fill that out with all the required stuff about the Loader API specifically, and examples of how to build your own loader. Take full creative license re: the content you think is helpful and necessary here, and I'll just review for an editing polish! I can suggest a model somewhat like the DevToolbar API or Image Services API pages as kind of an idea. Basically, exhaustive API reference and how to build your own both on this one page seems fitting to me.

  • I am adding stuff re: glob loading taking an array right now!

@sarah11918
Copy link
Member Author

Merging this in! Will do any final polishing on the branch directly!

@sarah11918 sarah11918 merged commit 9df5a3f into 5.0.0-beta Sep 10, 2024
5 checks passed
@sarah11918 sarah11918 deleted the sarah-content-reorg branch September 10, 2024 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0.0-beta i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants