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

[v3 checks] markdown.draft #4318

Closed
sarah11918 opened this issue Aug 22, 2023 · 2 comments
Closed

[v3 checks] markdown.draft #4318

sarah11918 opened this issue Aug 22, 2023 · 2 comments
Assignees
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description) v3.0

Comments

@sarah11918
Copy link
Member

📚 Subject area/topic

markdown.draft

📋 Page(s) affected (or suggested, for new content)

https://docs.astro.build/en/guides/markdown-content/#draft-pages

📋 General description or bullet points (if proposing new content)

@bluwy to check this section of the Markdown page and make any relevant changes based on withastro/astro#8099 (markdown.draft deprecated). Notably (but not limited to, if you notice something else!!):

  1. Is mdx.draft still fine?
  2. Is the method of Astro.glob() shown for filtering based on draft:true still fine, BUT the config option to build by default is gone, or should the ENTIRE notion of draft Markdown pages when NOT using content collections be removed?

Thanks! 🙌

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

none

@sarah11918 sarah11918 added improve documentation Enhance existing documentation (e.g. add an example, improve description) v3.0 labels Aug 22, 2023
@bluwy
Copy link
Member

bluwy commented Aug 24, 2023

I'll send a PR, but gonna fill in the answers here for context first:

  1. Is mdx.draft still fine?

Anything draft except via content collections should be removed. So MDX drafts should also be removed, but markdown would be the most common case especially that our option is named markdown.draft when referring it.

2. Is the method of Astro.glob() shown for filtering based on draft:true still fine, BUT the config option to build by default is gone, or should the ENTIRE notion of draft Markdown pages when NOT using content collections be removed?

Yeah I think Astro.glob and filter by draft: true is fine. But now it's more like a "this is a trick you can use if you have draft pages", than a feature to cover. So I think it makes more sense to remove it entirely?

Could also be less confusing if someone searches for "draft pages" and we'd only have one with content collections only. 🤔

@sarah11918
Copy link
Member Author

Not sure why this wasn't closed automatically, but closed by #4354 ! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description) v3.0
Projects
None yet
Development

No branches or pull requests

2 participants